more hlint cleanups

[functorrent.git] / README.md

diff --git a/README.md b/README.md
index 0017f5a9ff18cccf423618bd4d962bbdf0fdcb09..869cd3c7849f5f17a54e6676322847ba17bf2730 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,48 +1,30 @@
-# A bittorrent client.
+# A command line 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)
+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.
 
-[![Build Status](https://travis-ci.org/vu3rdd/functorrent.svg?branch=master)](https://travis-ci.org/vu3rdd/functorrent)
-
-## Building
-
-Functorrent can be build with [Stack](https://github.com/commercialhaskell/stack) or
-[Nix](https://nixos.org/nix/).
-
-### 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
 to be given in stdin. So
 
-$ cat ubuntu-14.10-desktop-amd64.iso.torrent | functorrent
-[....]
+    $ cat ubuntu-14.10-desktop-amd64.iso.torrent | functorrent
+    [....]
 
 Or one can explicitly specify the torrent file as input.
 
-$ functorrent ubuntu-14.10-desktop-amd64.iso.torrent
-[...]
+    $ 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")
@@ -54,19 +36,24 @@ $ functorrent ubuntu-14.10-desktop-amd64.iso.torrent
 - 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.
+- can download files. But needs every piece to be served by the peer it connected to.
 
-- can decode torrent files (bencoding)
-- 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)
+### 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.
 
 ## TODO
 
 *    Test suite.
-*    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).
+*    Talk to multiple peers concurrently.
+*    Piece download algorithms.
+*    Multifile torrent support.
+*    other advanced features of BitTorrent (like DHT).
+
+### Misc
+
+The Bangalore Haskell group forked an early version of this code and started to develop it as a group. My code has diverged a lot from it. Both are calling it functorrent. Perhaps that needs to be fixed.