Contributing

For easy development, nix with flakes support is recommended.

Test

Compile and run the test suite with:

$ nix build

or

$ mkdir build && cd build
$ meson ..
$ ninja test

Format

$ nix fmt

Documentation

Build the mmdoc docs to ./result with:

$ nix develop -c doc-build

Continuosly build the mmdoc docs and serve them on port 8000 with:

$ nix develop -c doc-watch

Nixpkgs manual

This is a temporary test that is in place while mmdoc is developed in tandem with the conversion of the nixpkgs manual to use Markdown. You can build my branch of nixpkgs-manual with:

Build the nixpkgs manual at ./result with:

$ nix develop -c np-build

Continuosly build the nixpkgs manual and serve them on port 8000 with:

$ nix develop -c np-watch

Making a new release

1. run ./contrib/release {major.minor.patch}. For example, ./contrib/release 0.16.0.
2. edit commit message
3. push commit and tags to GitHub