# A bittorrent client.
+[![Join the chat at https://gitter.im/vu3rdd/functorrent](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vu3rdd/functorrent?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
[![Build Status](https://travis-ci.org/vu3rdd/functorrent.svg?branch=master)](https://travis-ci.org/vu3rdd/functorrent)
-## building
+## Building
-I suggest using cabal sandbox.
+Functorrent can be build with [Cabal](https://www.haskell.org/cabal/) sandbox or
+[Nix](https://nixos.org/nix/).
-Or you can use [Nix](https://nixos.org/nix/), in which case, typing ```nix-shell```
-at the root of the source code repo should drop you into a shell which has all the package
-dependencies installed.
+### Cabal sandbox
-### Steps:
+Sandboxes give you per project independent containers, just like Python's
+virtualenv.
-## for cabal sandbox
-clone the repo; cd functorrent;
+ $ git clone https://github.com/vu3rdd/functorrent && cd functorrent
$ cabal sandbox init
- $ wget http://www.stackage.org/lts/cabal.config
$ cabal install --only-dependencies --enable-tests
$ cabal build # binaries in ./dist/built/functorrent/*
-## for nix
+### Building with Nix
+
+``$ nix-shell``` at the root of the source code repo should drop you into a
+shell which has all the package dependencies installed.
+
$ nix-shell --pure
[...]
## Goals
+- [Optimized for Fun](http://www.slideshare.net/autang/ofun-optimizing-for-fun).
+ (should have called it "funtorrent")
- Become more profient with Haskell.
- Implement something non-trivial with Haskell (crypto, file operations, network
operations, concurrency, bit twiddling, DHT).
-- Follow the spec - https://wiki.theory.org/BitTorrentSpecification
+- Follow the spec ([official spec](http://bittorrent.org/beps/bep_0003.html), [unofficial spec](https://wiki.theory.org/BitTorrentSpecification))
- Easy for newbies like me to read and understand along side the spec.
- doctest and quickcheck tests.
- Follow Haskell Style Guide - https://github.com/tibbe/haskell-style-guide/blob/master/haskell-style.md
- talk to the tracker and get the peer list
- the `main' program takes a torrent file (in the local file system) as input and
prints the {ip,port} for each peer, after talking to the tracker.
+- can handshake with the peer.
+- peer wire protocol (in progress)
## TODO
* Test suite.
-* Peer protocol.
+* Peer protocol (in progress).
* Get the file download working in the simplest possible way.
* Concurrency (threads per peer)
* other advanced features of Bit Torrent (like DHT).