Add cabal.config from stackage snapshot lts 2.5

[functorrent.git] / README.md

diff --git a/README.md b/README.md
index a3b6db80fc6355504ca24517c06ad57f3cb7406b..3a0dad069cc45d3c885874a035434205fbf1b285 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,20 +1,33 @@
 # 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
+## Building
 
-I suggest using cabal sandbox.
+Functorrent can be build with [Cabal](https://www.haskell.org/cabal/) sandbox or
+[Nix](https://nixos.org/nix/).
 
-### Steps:
+### Cabal sandbox
 
-clone the repo; cd functorrent;
+Sandboxes give you per project independent containers, just like Python's
+virtualenv.
 
+
+    $ git clone https://github.com/vu3rdd/functorrent && cd functorrent
     $ cabal sandbox init
-    $ wget http://www.stackage.org/lts/cabal.config
     $ cabal install --only-dependencies --enable-tests
     $ cabal build # binaries in ./dist/built/functorrent/*
 
+### Building with Nix
+
+``$ nix-shell``` at the root of the source code repo should drop you into a
+shell which has all the package dependencies installed.
+
+
+    $ nix-shell --pure
+    [...]
+    [nix-shell] $ cabal configure && cabal build
+
 ## Goals
 
 - Become more profient with Haskell.