diff options
| author | Marc Coquand <marcc@fastmail.fr> | 2023-12-04 20:26:24 -0600 |
|---|---|---|
| committer | Marc Coquand <marcc@fastmail.fr> | 2023-12-04 20:26:24 -0600 |
| commit | 74302c853031998f8d36813d953bea649f1f59bb (patch) | |
| tree | 222e47cb46a89c425c4549a569b0a787076c6c48 | |
| parent | adc54e70b6ae1fe65ac6c1f76ae32f4b4541afb3 (diff) | |
| download | wormhole-74302c853031998f8d36813d953bea649f1f59bb.tar.gz wormhole-74302c853031998f8d36813d953bea649f1f59bb.tar.bz2 wormhole-74302c853031998f8d36813d953bea649f1f59bb.zip | |
update readme
| -rw-r--r-- | readme.md | 16 |
1 files changed, 13 insertions, 3 deletions
@@ -14,14 +14,24 @@ I built it in OCaml because it is by far the most underrated programming languag ## Prerequisites -You'll need `libev`, `gmp` and `openssl`. See the Dockerfile. +You'll need [nix](https://nixos.org/) to run it locally. It sets everything up to make it dead easy +to run locally. -At some point I'll port this all to nix so you can use nix-shell. +You'll need to have the experimental flags nix-command and flakes set for it to work. + +Alternatively, you can execute each command with the flag + +``` +--extra-experimental-features "nix-command flakes" +``` + +And it will work to. ## Running locally ``` -ENV=DEV DISABLE_AUTH=true dune exec --watch --root . wormhole +nix build . # Will take a long time the first time, after that it will go very fast. +ENV=DEV DISABLE_AUTH=true nix develop -c dune exec --watch --root . wormhole ``` Dev flag adds some mock data. |