From: Ramakrishnan Muthukrishnan <ram@rkrishnan.org>
Date: Tue, 29 Sep 2015 13:50:41 +0000 (+0530)
Subject: Nuke the gitter.im link, Nix insructions etc
X-Git-Url: https://git.rkrishnan.org/?p=functorrent.git;a=commitdiff_plain;h=f46f0151ebac1cd0a521c1dc6ba5e0ec0beec9f6

Nuke the gitter.im link, Nix insructions etc
---

diff --git a/README.md b/README.md
index 792336a..eb8f431 100644
--- a/README.md
+++ b/README.md
@@ -2,34 +2,15 @@
 
 I started writing a BitTorrent client because it seemed like fun and I am learning Haskell and wanted to see if I can write something real with Haskell than just heat the room. It is turning out to be a lot of fun.
 
-[![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)
-
-## Building
-
-Functorrent can be build with [Stack](https://github.com/commercialhaskell/stack) or
-[Nix](https://nixos.org/nix/). I personally test the build with Debian GNU/Linux and
-OS X using FP Complete's stack.
-
-### Stack
-
-Sandboxes give you per project independent containers, just like Python's
-virtualenv.
+### Building
 
+You need to install [Stack](https://github.com/commercialhaskell/stack), either via
+the OS package manager or via `cabal` (`cabal install stack`).
 
     $ git clone https://github.com/vu3rdd/functorrent && cd functorrent
     $ cabal install stack # or install stack by other means
     $ stack build # binaries in $(pwd)/.stack-work/install/x86..../lts-2.16/7.8.4/bin/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
-
 ### Usage
 
 If you invoke functorrent without any options, it expects the contents of a torrent file
@@ -43,7 +24,7 @@ Or one can explicitly specify the torrent file as input.
     $ functorrent ubuntu-14.10-desktop-amd64.iso.torrent
     [...]
 
-## Goals
+### Goals
 
 - [Optimized for Fun](http://www.slideshare.net/autang/ofun-optimizing-for-fun).
   (should have called it "funtorrent")
@@ -55,15 +36,15 @@ Or one can explicitly specify the torrent file as input.
 - doctest and quickcheck tests.
 - Follow Haskell Style Guide - https://github.com/tibbe/haskell-style-guide/blob/master/haskell-style.md
 
-## Current Status
+### Current Status
 
 - most of the peer wire protocol works.
 - talks only to one peer at the moment. Single threaded.
 - can download files. But needs every piece to be served by the peer it connected to.
 
-## WARNING
+### WARNING
 
-- this client is not usable as your daily BitTorrent client yet. You may get corrupted files and end up wasting a lot of bandwidth. So, until we achieve some robustness, consider this as a programmer-friendly project to learn about a bunch of stuff.
+This client is not usable as your daily BitTorrent client yet. You may get corrupted files and end up wasting a lot of bandwidth. So, until we achieve some robustness, consider this as a programmer-friendly project to learn about a bunch of stuff.
 
 ## TODO