README: a note on using nix-shell

[functorrent.git] / README.md

diff --git a/README.md b/README.md
index a3b6db80fc6355504ca24517c06ad57f3cb7406b..691450858c142f8ea14e243dc410a49baf169aee 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +1,18 @@
 # A bittorrent client.
 
-[https://travis-ci.org/vu3rdd/functorrent](file:https://travis-ci.org/vu3rdd/functorrent.svg?branch=master)
+[![Build Status](https://travis-ci.org/vu3rdd/functorrent.svg?branch=master)](https://travis-ci.org/vu3rdd/functorrent)
 
 ## building
 
 I suggest using cabal sandbox.
 
+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
@@ -15,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.