README

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