Tests for decode

[functorrent.git] / README

diff --git a/README b/README
index 497fbb09d508ab19ae025b956bbef49249068b8a..5ab648c141b8f9cefa75aa5db7c7b6f8c1eb7d40 100644 (file)
--- a/README
+++ b/README
@@ -1,33 +1,43 @@
-From WordNet (r) 3.0 (2006) [wn]:
-
-  deluge
-      n 1: an overwhelming number or amount; "a flood of requests"; "a
-           torrent of abuse" [syn: {flood}, {inundation}, {deluge},
-           {torrent}]
-      2: a heavy rain [syn: {downpour}, {cloudburst}, {deluge},
-         {waterspout}, {torrent}, {pelter}, {soaker}]
-      3: the rising of a body of water and its overflowing onto
-         normally dry land; "plains fertilized by annual inundations"
-         [syn: {flood}, {inundation}, {deluge}, {alluvion}]
-      v 1: fill quickly beyond capacity; as with a liquid; "the
-           basement was inundated after the storm"; "The images
-           flooded his mind" [syn: {deluge}, {flood}, {inundate},
-           {swamp}]
-      2: charge someone with too many tasks [syn: {overwhelm},
-         {deluge}, {flood out}]
-      3: fill or cover completely, usually with water [syn:
-         {inundate}, {deluge}, {submerge}]
-
-`deluge' is a bittorrent client.
+`functorrent' is a bittorrent client.
 
 building
 --------
 
-I suggest usign cabal sandbox.
+I suggest using cabal sandbox.
 
 Steps:
 
+clone the repo; cd functorrent;
+
 1. cabal sandbox init
-2. cabal install --only-dependencies
-3. cabal build
+2. wget http://www.stackage.org/lts/cabal.config
+3. cabal install --only-dependencies --enable-tests
+4. cabal build # binaries in ./dist/built/functorrent/*
+
+Goals
+-----
+
+- Become more profient with Haskell.
+- Implement something non-trivial with Haskell (crypto, file operations, network
+  operations, concurrency, bit twiddling, DHT).
+- Follow the spec - https://wiki.theory.org/BitTorrentSpecification
+- Easy for newbies like me to read and understand along side the spec.
+- doctest and quickcheck tests.
+- Follow Haskell Style Guide - https://github.com/tibbe/haskell-style-guide/blob/master/haskell-style.md
+
+Current Status
+--------------
+
+- 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.
+
+TODO
+----
 
+- Test suite.
+- Peer protocol.
+- Get the file download working in the simplest possible way.
+- Concurrency (threads per peer)
+- other advanced features of Bit Torrent (like DHT).