Add nix instructions for developers (#58)

* add nix instructions Signed-off-by: Matthias J. Kannwischer <[email protected]> * add dev setup documentation Signed-off-by: Matthias J. Kannwischer <[email protected]> * fix typo Signed-off-by: Matthias J. Kannwischer <[email protected]> * Minor improvements Signed-off-by: Hanno Becker <[email protected]> --------- Signed-off-by: Matthias J. Kannwischer <[email protected]> Signed-off-by: Hanno Becker <[email protected]> Co-authored-by: Hanno Becker <[email protected]>
pq-code-package · Jun 17, 2024 · 45c91ee · 45c91ee
1 parent 9323f59
commit 45c91ee
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -41,6 +41,29 @@ Once we have the first stable version, this notice will be removed.
 
 The current code is compatible with the [`standard` branch of the official MLKEM repository](https://github.com/pq-crystals/kyber/tree/standard).
 
+
+## Development
+
+### Environment Setup
+
+All the development and build dependencies are specified in [flake.nix](flake.nix). We recommend installing them using [nix](https://nixos.org/download/).
+
+- **Setup with nix**
+    - Running `nix develop` will execute a bash shell with the development environment specified in [flake.nix](flake.nix).
+    - Alternatively, you can enable `direnv` by using `direnv allow`, allowing it to handle the environment setup for you.
+
+    - As flake is still an experimental feature of nix, `--experimental-features 'nix-command flakes'` is needed when running the nix command. Alternatively, add the following to your `~/.config/nix/nix.conf` or `/etc/nix/nix.conf`:
+```
+experimental-features = nix-command flakes
+```
+
+- If you are not using nix, please ensure you have installed the same versions as specified in [flake.nix](flake.nix).
+
+### Development scripts
+After running `nix develop` you should automatically have a number of support scripts in your PATH:
+
+- [`format`](scripts/format) formats all files. The format is enforced by our CI, so you should run this script prior to committing.
+
 ## Call for contributors
 
 We are actively seeking contributors who can help us build **mlkem-c-aarch64**.