Skip to content

Commit

Permalink
Split the README into TODO and INSTALL.
Browse files Browse the repository at this point in the history
  • Loading branch information
jlouis committed Dec 21, 2009
1 parent 3b0b271 commit 8630bbc
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 47 deletions.
4 changes: 4 additions & 0 deletions INSTALL.md
@@ -0,0 +1,4 @@
Installation instructions
=========================

Write me!
49 changes: 2 additions & 47 deletions README.md
Expand Up @@ -10,53 +10,8 @@ and I need to be written by some generous soul!
Usage
-----------------

Currently, it is all very simple: `make` followed by `./Main
file.torrent` is all that turns out to be supported at the moment.

The TODO list
-----------------

The list of things that needs done. Feel free to take anything on the
list if you want, but do coordinate so we don't do multiple work on
the same thing. Feel free to add anything to the list as well. It
partially acts like a bug tracker at the moment in addition to being a
wish-list.

* Change the sender Queue into having two queues, one for short
messages and one for long messages.
* hFlush on the sender queue in the sender process, intelligently.
There is no reason to flush the queue before we are fairly sure
we got all the small messages into it. It is dependent on the
above part.
* Optimize reading of blocks by moving it to the sender Process in
The Peer Process
* Don't connect twice to the same client id. Track the clients we
connected to.
* Make it possible to Poison OMBox'es. Currently we leak due to them.
* Handle error cases when checking a torrent file.
* Add support for DHT
* Add support for multiple files
* Add rate limitation support, locally or globally
* Add leeching support
* Add support for multiple torrents at once
* Add prioritization support of multiTorrents
* Support the FAST extension
* Support UDP tracking extension
* Support partial downloads (select files you want in the torrent)
* Write an ETA estimator
* Implement a creator for torrent files
* Implement a scraper on trackers
* Turn the logging system into a better framework, add log levels,
add process names so we can see who is doing what.
* If we get a wrong URI, the code currently deadlocks since the tracker
dies. Handle this problem gracefully.
* Cleanup the BCode module, while keeping the interface somewhat
stable. The code is an utter mess as it stands right now.
* Improve the cabal file for the project, check with GHC 6.12.1,
provide correct versions of needed packages.
* Implement the PieceManager code; the documentation explains what it
must do.
* Make the client into an eligible leecher.
We are using cabal for the build. The top-level Makefile will be default
attempt a user install into $HOME by using cabal-install.

Odd bugs
--------
Expand Down
46 changes: 46 additions & 0 deletions TODO.md
@@ -0,0 +1,46 @@
The TODO list
=============

(Perhaps change this into an emacs org-mode TODO file)

The list of things that needs done. Feel free to take anything on the
list if you want, but do coordinate so we don't do multiple work on
the same thing. Feel free to add anything to the list as well. It
partially acts like a bug tracker at the moment in addition to being a
wish-list.

* Change the sender Queue into having two queues, one for short
messages and one for long messages.
* hFlush on the sender queue in the sender process, intelligently.
There is no reason to flush the queue before we are fairly sure
we got all the small messages into it. It is dependent on the
above part.
* Optimize reading of blocks by moving it to the sender Process in
The Peer Process
* Don't connect twice to the same client id. Track the clients we
connected to.
* Make it possible to Poison OMBox'es. Currently we leak due to them.
* Handle error cases when checking a torrent file.
* Add support for DHT
* Add support for multiple files
* Add rate limitation support, locally or globally
* Add leeching support
* Add support for multiple torrents at once
* Add prioritization support of multiTorrents
* Support the FAST extension
* Support UDP tracking extension
* Support partial downloads (select files you want in the torrent)
* Write an ETA estimator
* Implement a creator for torrent files
* Implement a scraper on trackers
* Turn the logging system into a better framework, add log levels,
add process names so we can see who is doing what.
* If we get a wrong URI, the code currently deadlocks since the tracker
dies. Handle this problem gracefully.
* Cleanup the BCode module, while keeping the interface somewhat
stable. The code is an utter mess as it stands right now.
* Improve the cabal file for the project, check with GHC 6.12.1,
provide correct versions of needed packages.
* Implement the PieceManager code; the documentation explains what it
must do.
* Make the client into an eligible leecher.

0 comments on commit 8630bbc

Please sign in to comment.