2022-06-25 21:53:50 +00:00
|
|
|
<!-- SPDX-FileCopyrightText: 2022 Anna <cyber@sysrq.in> -->
|
|
|
|
|
<!-- SPDX-License-Identifier: CC0-1.0 -->
|
|
|
|
|
|
|
|
|
|
nimbus
|
|
|
|
|
======
|
|
|
|
|
|
|
|
|
|
**nimbus** is a **Nim** **bu**ild **s**ystem. You can also call in NimBS. Nimja
|
|
|
|
|
would also be a clever name but it's already taken.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Raison d'être
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
[nimble](https://github.com/nim-lang/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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Dependencies
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
**nimbus** only generates `build.ninja` files, so you'll need [ninja][ninja]
|
|
|
|
|
or [samurai][samurai] to use it.
|
|
|
|
|
|
|
|
|
|
[ninja]: https://ninja-build.org/
|
|
|
|
|
[samurai]: https://github.com/michaelforney/samurai
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Installing
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
* Using nimble:
|
|
|
|
|
|
|
|
|
|
`nimble install`
|
|
|
|
|
|
2022-06-28 23:01:47 +00:00
|
|
|
* Using just Nim compiler:
|
2022-06-25 21:53:50 +00:00
|
|
|
|
2022-06-28 23:01:47 +00:00
|
|
|
nim c src/nimbus
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Testing
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
$ testament all
|
|
|
|
|
```
|
2022-06-25 21:53:50 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
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>.
|
|
|
|
|
|
|
|
|
|
[1]: https://git-send-email.io/
|
|
|
|
|
[2]: https://git-scm.com/docs/git-request-pull
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
* BSD-3-Clause
|
|
|
|
|
* Apache-2.0 (`ninja_syntax.nim`)
|
