diff options
Diffstat (limited to 'bittorrent/README.md')
| -rw-r--r-- | bittorrent/README.md | 78 |
1 files changed, 0 insertions, 78 deletions
diff --git a/bittorrent/README.md b/bittorrent/README.md deleted file mode 100644 index 32948896..00000000 --- a/bittorrent/README.md +++ /dev/null | |||
| @@ -1,78 +0,0 @@ | |||
| 1 | ### BitTorrent [![Build Status][1]][2] | ||
| 2 | |||
| 3 | A [BitTorrent][0] library implementation. It allows to read/write | ||
| 4 | torrent files, transfer data files, query trackers and DHT. The | ||
| 5 | library is still in active development and have some subsystems | ||
| 6 | partially implemented. | ||
| 7 | |||
| 8 | For lastest released version and reference documentation see [hackage][3] page. | ||
| 9 | |||
| 10 | [0]: http://bittorrent.org/beps/bep_0000.html | ||
| 11 | [1]: https://travis-ci.org/cobit/bittorrent.png | ||
| 12 | [2]: https://travis-ci.org/cobit/bittorrent | ||
| 13 | [3]: http://hackage.haskell.org/package/bittorrent | ||
| 14 | |||
| 15 | ### Status | ||
| 16 | |||
| 17 | The protocol has [many enchancements][bep-list]. This table keep track | ||
| 18 | if a particular BEP is "todo", "in progress" or "complete": | ||
| 19 | |||
| 20 | | BEP # | Title | Status | ||
| 21 | |:-----:|:--------------------------------------------------:|:----------- | ||
| 22 | | 3 | [The BitTorrent Protocol Specification][bep3] | [In progress][bep3-impl] | ||
| 23 | | 4 | [Known Number Allocations][bep4] | [In progress][bep4-impl] | ||
| 24 | | 5 | [DHT][bep5] | [In progress][bep5-impl] | ||
| 25 | | 6 | [Fast Extension][bep6] | [In progress][bep6-impl] | ||
| 26 | | 7 | [IPv6 Tracker Extension][bep7] | [In progress][bep7-impl] | ||
| 27 | | 9 | [Extension for Peers to Send Metadata Files][bep9] | [In progress][bep9-impl] | ||
| 28 | | 10 | [Extension protocol][bep10] | [In progress][bep10-impl] | ||
| 29 | | 12 | [Multitracker Metadata Extension][bep10] | [In progress][bep12-impl] | ||
| 30 | | 15 | [UDP Tracker Protocol for BitTorrent][bep15] | [In progress][bep15-impl] | ||
| 31 | | 20 | [Peer ID Conventions][bep20] | [Implemented][bep20-impl] | ||
| 32 | | 23 | [Tracker Return Compact Peer Lists][bep23] | [Implemented][bep23-impl] | ||
| 33 | |||
| 34 | [bep-list]: http://www.bittorrent.org/beps/bep_0000.html | ||
| 35 | [bep3]: http://www.bittorrent.org/beps/bep_0003.html | ||
| 36 | [bep4]: http://www.bittorrent.org/beps/bep_0004.html | ||
| 37 | [bep5]: http://www.bittorrent.org/beps/bep_0005.html | ||
| 38 | [bep6]: http://www.bittorrent.org/beps/bep_0006.html | ||
| 39 | [bep7]: http://www.bittorrent.org/beps/bep_0007.html | ||
| 40 | [bep9]: http://www.bittorrent.org/beps/bep_0009.html | ||
| 41 | [bep10]: http://www.bittorrent.org/beps/bep_0010.html | ||
| 42 | [bep12]: http://www.bittorrent.org/beps/bep_0012.html | ||
| 43 | [bep15]: http://www.bittorrent.org/beps/bep_0015.html | ||
| 44 | [bep20]: http://www.bittorrent.org/beps/bep_0020.html | ||
| 45 | [bep23]: http://www.bittorrent.org/beps/bep_0023.html | ||
| 46 | |||
| 47 | [bep3-impl]: src | ||
| 48 | [bep4-impl]: src/Network/BitTorrent/Exchange/Message.hs | ||
| 49 | [bep5-impl]: src/Network/BitTorrent/DHT/Protocol.hs | ||
| 50 | [bep6-impl]: src/Network/BitTorrent/Exchange/Message.hs | ||
| 51 | [bep7-impl]: src/Network/BitTorrent/Tracker/Message.hs | ||
| 52 | [bep9-impl]: src/Network/BitTorrent/Exchange/Wire.hs | ||
| 53 | [bep10-impl]: src/Network/BitTorrent/Exchange/Message.hs | ||
| 54 | [bep12-impl]: src/Data/Torrent.hs | ||
| 55 | [bep15-impl]: src/Network/BitTorrent/Tracker/RPC/UDP.hs | ||
| 56 | [bep20-impl]: src/Network/BitTorrent/Core/Fingerprint.hs | ||
| 57 | [bep23-impl]: src/Network/BitTorrent/Tracker/Message.hs | ||
| 58 | |||
| 59 | ### Hacking | ||
| 60 | |||
| 61 | The root directory layout is as follows: | ||
| 62 | |||
| 63 | * examples -- includes demo utilities to get started; | ||
| 64 | * src -- the library source tree; | ||
| 65 | * tests -- the library test suite; | ||
| 66 | * res -- torrents and data files used in test suite. | ||
| 67 | * sub -- subprojects and submodules used by the library and still in dev. | ||
| 68 | |||
| 69 | Some subdirectories includes README with futher explanations to get started. | ||
| 70 | |||
| 71 | ### Contacts | ||
| 72 | |||
| 73 | * Discussions: IRC [#haskell-bittorrent][irc] at irc.freenode.net | ||
| 74 | * Bugs & issues: [issue tracker][tracker] | ||
| 75 | * Maintainer: <pxqr.sta@gmail.com> | ||
| 76 | |||
| 77 | [tracker]: https://github.com/cobit/bittorrent/issues/new | ||
| 78 | [irc]: http://webchat.freenode.net/?channels=haskell-bittorrent | ||