README.md

   1 # A bittorrent client.
   2
   3 [![Build Status](https://travis-ci.org/vu3rdd/functorrent.svg?branch=master)](https://travis-ci.org/vu3rdd/functorrent)
   4
   5 ## building
   6
   7 I suggest using cabal sandbox.
   8
   9 Or you can use Nix pkg, in which case, typing `nix-shell' at the root of the
  10 source code repo should drop you into a shell which has all the package
  11 dependencies installed.
  12
  13 ### Steps:
  14
  15 clone the repo; cd functorrent;
  16
  17     $ cabal sandbox init
  18     $ wget http://www.stackage.org/lts/cabal.config
  19     $ cabal install --only-dependencies --enable-tests
  20     $ cabal build # binaries in ./dist/built/functorrent/*
  21
  22 ## Goals
  23
  24 - Become more profient with Haskell.
  25 - Implement something non-trivial with Haskell (crypto, file operations, network
  26   operations, concurrency, bit twiddling, DHT).
  27 - Follow the spec - https://wiki.theory.org/BitTorrentSpecification
  28 - Easy for newbies like me to read and understand along side the spec.
  29 - doctest and quickcheck tests.
  30 - Follow Haskell Style Guide - https://github.com/tibbe/haskell-style-guide/blob/master/haskell-style.md
  31
  32 ## Current Status
  33
  34 - can decode torrent files (bencoding)
  35 - talk to the tracker and get the peer list
  36 - the `main' program takes a torrent file (in the local file system) as input and
  37   prints the {ip,port} for each peer, after talking to the tracker.
  38
  39 ## TODO
  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).