README: a note on using nix-shell
authorRamakrishnan Muthukrishnan <ram@rkrishnan.org>
Sun, 26 Apr 2015 17:50:55 +0000 (23:20 +0530)
committerRamakrishnan Muthukrishnan <ram@rkrishnan.org>
Sun, 26 Apr 2015 17:50:55 +0000 (23:20 +0530)
README.md

index 77146811c5bde3afbb0af6fc7517e8c7cb5ec68c..691450858c142f8ea14e243dc410a49baf169aee 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,12 +6,13 @@
 
 I suggest using cabal sandbox.
 
-Or you can use Nix pkg, in which case, typing `nix-shell' at the root of the
-source code repo should drop you into a shell which has all the package
+Or you can use [Nix](https://nixos.org/nix/), in which case, typing ```nix-shell```
+at the root of the source code repo should drop you into a shell which has all the package
 dependencies installed.
 
 ### Steps:
 
+## for cabal sandbox
 clone the repo; cd functorrent;
 
     $ cabal sandbox init
@@ -19,6 +20,12 @@ clone the repo; cd functorrent;
     $ cabal install --only-dependencies --enable-tests
     $ cabal build # binaries in ./dist/built/functorrent/*
 
+## for nix
+
+    $ nix-shell --pure
+    [...]
+    [nix-shell] $ cabal configure && cabal build
+
 ## Goals
 
 - Become more profient with Haskell.