README.md

   1 # 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 I suggest using cabal sandbox.
   8
   9 ### Steps:
  10
  11 clone the repo; cd functorrent;
  12
  13     $ cabal sandbox init
  14     $ wget http://www.stackage.org/lts/cabal.config
  15     $ cabal install --only-dependencies --enable-tests
  16     $ cabal build # binaries in ./dist/built/functorrent/*
  17
  18 ## Goals
  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 - can decode torrent files (bencoding)
  31 - talk to the tracker and get the peer list
  32 - the `main' program takes a torrent file (in the local file system) as input and
  33   prints the {ip,port} for each peer, after talking to the tracker.
  34
  35 ## TODO
  36
  37 *    Test suite.
  38 *    Peer protocol.
  39 *    Get the file download working in the simplest possible way.
  40 *    Concurrency (threads per peer)
  41 *    other advanced features of Bit Torrent (like DHT).