CyberTaIlor
/
nimbus
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docs: describe development status

This commit is contained in:
Anna “CyberTailor” 2024-01-11 09:47:01 +05:00
parent f5db071e0c
commit aaf142eecf
Signed by: CyberTaIlor
GPG Key ID: E7B76EDC50864BB1
3 changed files with 28 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,4 +1,4 @@
<!-- SPDX-FileCopyrightText: 2022 Anna <cyber@sysrq.in> -->
<!-- SPDX-FileCopyrightText: 2022-2024 Anna <cyber@sysrq.in> -->
<!-- SPDX-License-Identifier: CC0-1.0 -->
nimbus
@ -31,9 +31,21 @@ This project is intended to be used with traditional package managers (primarly
with Gentoo's Portage). But maybe it'll be useful for other purposes too.
Development status
------------------
This software is considered [completed][ddv-post] and stable. No new features
are planned, however there will be releases for bug fixes and compatibility
updates.
[ddv-post]: https://drewdevault.com/2021/01/04/A-culture-of-stability-and-reliability.html
Dependencies
------------
This software has no build dependencies other than the Nim standard library.
**nimbus** only generates `build.ninja` files, so you'll need [ninja][ninja]
or [samurai][samurai] to use it.
@ -75,8 +87,9 @@ You can track new releases using an [atom feed][atom] provided by GitHub.
Contributing
------------
Patches and pull requests are welcome. Please use either [git-send-email(1)][1]
or [git-request-pull(1)][2], addressed to <cyber@sysrq.in>.
Patches and pull requests are welcome. Please use either
[git-send-email(1)][git-send-email] or [git-request-pull(1)][git-request-pull],
addressed to <cyber@sysrq.in>.
Your commit message should conform to the following standard:
@ -90,8 +103,8 @@ sure to reference any bug reports and other contributors. Make
sure the correct authorship appears.
```
[1]: https://git-send-email.io/
[2]: https://git-scm.com/docs/git-request-pull
[git-send-email]: https://git-send-email.io/
[git-request-pull]: https://git-scm.com/docs/git-request-pull
IRC

2
docs/getting-started.rst
View File

@ -55,7 +55,7 @@ Run tests
ninja test
This command will run "test" task (if defined). Otherwise, it will compile and
run all Nim files in the file:`tests` directory beginning with "t" in their
run all Nim files in the :file:`tests` directory beginning with "t" in their
filename.
This behavior is compatible with Nimble.

10
docs/index.rst
View File

@ -1,4 +1,4 @@
.. SPDX-FileCopyrightText: 2022-2023 Anna <cyber@sysrq.in>
.. SPDX-FileCopyrightText: 2022-2024 Anna <cyber@sysrq.in>
..
.. SPDX-License-Identifier: BSD-3-Clause
@ -37,3 +37,11 @@ nimble is a great tool for development but it does not get on well with system
package managers. This project is intended to be used with traditional package
managers (primarly with Gentoo's Portage). But maybe it'll be useful for other
purposes too.
Development status
------------------
This software is considered `completed`__ and stable. No new features are
planned, however there will be releases for bug fixes and compatibility updates.
__ https://drewdevault.com/2021/01/04/A-culture-of-stability-and-reliability.html