Create NixREADME.md

nix/NixREADME.md

@@ -0,0 +1,16 @@
+# Shunpo with Nix
+A nix flake for Shunpo is provided in `nix/flake.nix`.  
+
+
+Building
+---
+You can test Shunpo by building the nix flake with  `nix build .` , which will generate a folder called `result`.  
+Next intialize Shunpo by running `source result/bin/shunpo_init`.
+
+Installation
+---
+To install the package run `nix install .#shunpo`, and initialize Shunpo by running `source shunpo_init`.
+If you would like to have Shunpo initialize by default, you can add an initialization line to your .bashrc by running:
+```
+echo "source shunpo_init" >> ~/.bashrc
+```