diff --git a/README.md b/README.md index 16f4058..0b5a2e5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - + 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 . +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 . 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 diff --git a/docs/getting-started.rst b/docs/getting-started.rst index 6bcb304..292eadb 100644 --- a/docs/getting-started.rst +++ b/docs/getting-started.rst @@ -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. diff --git a/docs/index.rst b/docs/index.rst index 76a2ca9..cd75c95 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,4 +1,4 @@ -.. SPDX-FileCopyrightText: 2022-2023 Anna +.. SPDX-FileCopyrightText: 2022-2024 Anna .. .. 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