README

   1 `functorrent' is a bittorrent client.
   2
   3 building
   4 --------
   5
   6 I suggest using cabal sandbox.
   7
   8 Steps:
   9
  10 clone the repo; cd functorrent;
  11
  12 1. cabal sandbox init
  13 2. wget http://www.stackage.org/lts/cabal.config
  14 3. cabal install --only-dependencies --enable-tests
  15 4. cabal build # binaries in ./dist/built/functorrent/*
  16
  17 Goals
  18 -----
  19
  20 - Become more profient with Haskell.
  21 - Implement something non-trivial with Haskell (crypto, file operations, network
  22   operations, concurrency, bit twiddling, DHT).
  23 - Follow the spec - https://wiki.theory.org/BitTorrentSpecification
  24 - Easy for newbies like me to read and understand along side the spec.
  25 - doctest and quickcheck tests.
  26 - Follow Haskell Style Guide - https://github.com/tibbe/haskell-style-guide/blob/master/haskell-style.md
  27
  28 Current Status
  29 --------------
  30
  31 - can decode torrent files (bencoding)
  32 - talk to the tracker and get the peer list
  33 - the `main' program takes a torrent file (in the local file system) as input and
  34   prints the {ip,port} for each peer, after talking to the tracker.
  35
  36 TODO
  37 ----
  38
  39 - Test suite.
  40 - Peer protocol.
  41 - Get the file download working in the simplest possible way.
  42 - Concurrency (threads per peer)
  43 - other advanced features of Bit Torrent (like DHT).