From 8125547cd8d74385a327fce26111f5e27c3d2b45 Mon Sep 17 00:00:00 2001
From: Yann Herklotz <git@yannherklotz.com>
Date: Mon, 1 Nov 2021 21:15:58 +0000
Subject: Update build instructions

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

(limited to 'README.md')

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
+```
-- 
cgit