From: Ramakrishnan Muthukrishnan Date: Sun, 12 Jul 2015 10:53:54 +0000 (+0530) Subject: Merge branch 'piece-manager' X-Git-Url: https://git.rkrishnan.org/?a=commitdiff_plain;h=fc0b86a82c6c8a3155163a1864820ea779ffb7e4;hp=-c;p=functorrent.git Merge branch 'piece-manager' --- fc0b86a82c6c8a3155163a1864820ea779ffb7e4 diff --combined README.md index 06af0f4,4885b0e..6100197 --- a/README.md +++ b/README.md @@@ -1,7 -1,5 +1,7 @@@ # 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 @@@ -32,12 -30,10 +32,12 @@@ shell which has all the package depende ## 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 @@@ -48,13 -44,11 +48,13 @@@ - 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).