]> git.rkrishnan.org Git - functorrent.git/commitdiff
Merge branch 'piece-manager'
authorRamakrishnan Muthukrishnan <ram@rkrishnan.org>
Sun, 12 Jul 2015 10:53:54 +0000 (16:23 +0530)
committerRamakrishnan Muthukrishnan <ram@rkrishnan.org>
Sun, 12 Jul 2015 10:53:54 +0000 (16:23 +0530)
1  2 
README.md

diff --combined README.md
index 06af0f49bf7ddc02c0f56b6c7a6ef3d066012302,4885b0ee28aa380009cb1f89762a675532ea8b61..61001971eae1fd0818a427a1b13f886c04466b17
+++ 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
  - 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).