Merge pull request #31 from gitter-badger/gitter-badge

[functorrent.git] / README.md

diff --git a/README.md b/README.md
index 77146811c5bde3afbb0af6fc7517e8c7cb5ec68c..06af0f49bf7ddc02c0f56b6c7a6ef3d066012302 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,26 +1,39 @@
 # A bittorrent client.
 
+[![Join the chat at https://gitter.im/vu3rdd/functorrent](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vu3rdd/functorrent?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 [![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/).
 
-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
-dependencies installed.
+### Cabal sandbox
 
-### Steps:
+Sandboxes give you per project independent containers, just like Python's
+virtualenv.
 
-clone the repo; cd functorrent;
 
+    $ 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
 
+- [Optimized for Fun](http://www.slideshare.net/autang/ofun-optimizing-for-fun).
+  (should have called it "funtorrent")
 - Become more profient with Haskell.
 - Implement something non-trivial with Haskell (crypto, file operations, network
   operations, concurrency, bit twiddling, DHT).
@@ -35,11 +48,13 @@ clone the repo; cd functorrent;
 - talk to the tracker and get the peer list
 - the `main' program takes a torrent file (in the local file system) as input and
   prints the {ip,port} for each peer, after talking to the tracker.
+- can handshake with the peer.
+- peer wire protocol (in progress)
 
 ## TODO
 
 *    Test suite.
-*    Peer protocol.
+*    Peer protocol (in progress).
 *    Get the file download working in the simplest possible way.
 *    Concurrency (threads per peer)
 *    other advanced features of Bit Torrent (like DHT).