From: b3nj5m1n Date: Sun, 12 Mar 2023 23:18:48 +0000 (+0100) Subject: Add instructions about using nix flake X-Git-Tag: v0.2.0.2~93 X-Git-Url: https://glassweightruler.freedombox.rocks/gitweb/xdg-ninja.git/commitdiff_plain/c1dc6c9694ead574b9bea4040ed5bbbcaacbe26a Add instructions about using nix flake --- diff --git a/README.md b/README.md index a86b9c7..d650c1f 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,13 @@ The configurations are from the [arch wiki page on XDG_BASE_DIR](https://wiki.ar ## Running +### Using nix + +If you're using [nix](https://nixos.org) and have flakes turned on, you can just run the following command: +```sh +nix run github:b3nj5m1n/xdg-ninja +``` + ### Cloning Manually Clone the repository somewhere, then run the _./xdg-ninja.sh_ script. @@ -48,15 +55,23 @@ Files in this directory can have any name, but using the name of the program is ### Automatically Generating Configuration -You can download the _xdgnj_ executable from the releases page. Alternatively you can build it from scratch using _cabal_, _stack_, or the provided docker image in _build/_. (To be clear, this is just a tool that will help you automatically generate the config files, you still only need your shell to run the tests) +You can download the _xdgnj_ executable from the releases page. Alternatively, you can use the nix flake or build it from scratch using _cabal_, _stack_, or the provided docker image in _build/_. (To be clear, this is just a tool that will help you automatically generate the config files, you still only need your shell to run the tests) Available commands: ```sh xdgnj add # Adds a new configuration xdgnj prev programs/FILE.json # Preview the configuration for a program +xdgnj edit programs/FILE.json # Edit the configuration for a program xdgnj run # Mostly the same as running the shell script ``` +#### Using nix + +If you're using [nix](https://nixos.org) and have flakes turned on, you can just run the following command: +```sh +nix run github:b3nj5m1n/xdg-ninja#xdgnj-bin ... +``` + #### Building from scratch You can use `cabal build`, `stack build`, or the provided dockerfile in _build/_.