From 7fb9eed60374e6de307ffea1c06271fadcf2c1a0 Mon Sep 17 00:00:00 2001 From: Knut Magnus Aasrud Date: Mon, 6 Nov 2023 11:37:04 +0100 Subject: [PATCH] docs: update README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index b0a96e29..1803fb3a 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,22 @@ WebAssembly backend. [wasm-pack]: https://rustwasm.github.io/wasm-pack/ +### Nix flake + +There is a Nix flake available in the `contrib` directory. With it, you can get +a reproducible build of Jotdown by cloning the repo and running + +``` +$ nix build ./contrib +``` + +If you want to the run Jotdown CLI on any system that has Nix installed, you can +do it like this: + +``` +$ nix run github:hellux/jotdown?dir=contrib -- +``` + ## Status ### Correctness