]> git.rkrishnan.org Git - functorrent.git/blobdiff - README
Use stackage
[functorrent.git] / README
diff --git a/README b/README
index f43b073d2cad94259c1be44a7daccf8cd7cf9ab9..928e7db093b6f100967c54c4c1128d45d28a2199 100644 (file)
--- a/README
+++ b/README
@@ -1,24 +1,4 @@
-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
 --------
@@ -27,9 +7,12 @@ I suggest using cabal sandbox.
 
 Steps:
 
+clone the repo; cd functorrent;
+
 1. cabal sandbox init
-2. cabal install --only-dependencies
-3. cabal build # binaries in ./dist/built/deluge/*
+2. wget http://www.stackage.org/lts/cabal.config
+3. cabal install --only-dependencies
+4. cabal build # binaries in ./dist/built/functorrent/*
 
 Goals
 -----
@@ -37,9 +20,10 @@ Goals
 - Become more profient with Haskell.
 - Implement something non-trivial with Haskell (crypto, file operations, network
   operations, concurrency, bit twiddling, DHT).
-- Spec compliance.
+- 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
 
 Status
 ------