CONTRIBUTING.md

Contributing to npc

GitHub issues and pull requests are welcome!

Working in this repository is pretty straightforward: you just use the dev shell via nix develop or direnv. To build and run npc itself, you can either use crane via nix run:

nix run . -- --help

Or you can just use cargo run:

cargo run --release -- --help

There are a couple lints you can run along with building the tool itself:

nix flake check

One lint uses markdown-toc to generate the table of contents in README.md; you can run it like this:

markdown-toc --bullets="-" -i README.md

Another lint uses svg-term to convert example.cast (generated via asciinema) to example.svg; you can run it like this:

svg-term --window --in example.cast --out example.svg