aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorYann Herklotz <git@yannherklotz.com>2021-11-01 21:15:58 +0000
committerYann Herklotz <git@yannherklotz.com>2021-11-01 21:15:58 +0000
commit8125547cd8d74385a327fce26111f5e27c3d2b45 (patch)
tree916d0e6915b2bd551892a6da1c3cacca05e4c3e8 /README.md
parenta00bf11df94e929aadc6d64792801cf3de58a601 (diff)
downloadgsa-parser-8125547cd8d74385a327fce26111f5e27c3d2b45.tar.gz
gsa-parser-8125547cd8d74385a327fce26111f5e27c3d2b45.zip
Update build instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md
index be18031..d7c6cb8 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,39 @@
# GSA Parser
+
+## Build Instructions
+
+First, install nix:
+
+``` sh
+curl -L https://nixos.org/nix/install | sh
+```
+
+It's recommended to use `flake` in nix, which is experimental:
+
+``` sh
+nix-env -iA nixpkgs.nixUnstable
+```
+
+Then add the following to `~/.config/nix/nix.conf`:
+
+``` text
+experimental-features = nix-command flakes
+```
+
+For faster compilation, use [cachix](https://www.cachix.org/) to download binary dependencies:
+
+``` sh
+nix-env -iA cachix -f https://cachix.org/api/v1/install
+```
+
+Then, activate the following cache:
+
+``` sh
+cachix use ymherklotz
+```
+
+Then build the project using:
+
+``` sh
+nix build
+```