Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kmaasrud committed Jan 9, 2024
1 parent 831fdba commit 7fb9eed
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 -- <arguments..>
```

## Status

### Correctness
Expand Down

0 comments on commit 7fb9eed

Please sign in to comment.