README

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