From 74302c853031998f8d36813d953bea649f1f59bb Mon Sep 17 00:00:00 2001 From: Marc Coquand Date: Mon, 4 Dec 2023 20:26:24 -0600 Subject: update readme --- readme.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index ede7628..b452f8a 100644 --- a/readme.md +++ b/readme.md @@ -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. -- cgit v1.2.3