diff options
| -rw-r--r-- | src/Network/BitTorrent/Readme.md | 15 | ||||
| -rw-r--r-- | src/Readme.md | 8 |
2 files changed, 17 insertions, 6 deletions
diff --git a/src/Network/BitTorrent/Readme.md b/src/Network/BitTorrent/Readme.md index 1a73254d..ebf9545e 100644 --- a/src/Network/BitTorrent/Readme.md +++ b/src/Network/BitTorrent/Readme.md | |||
| @@ -1,7 +1,10 @@ | |||
| 1 | To avoid module dependency hell Network.BitTorrent.$X modules could | 1 | Layout |
| 2 | depend on: | 2 | ====== |
| 3 | 3 | ||
| 4 | * Data.Torrent.* modules | 4 | | module group | can import | main purpose | |
| 5 | * Network.BitTorrent.Core.* modules | 5 | |:-------------|:------------:|:--------------------------------------:| |
| 6 | * Network.BitTorrent.$X.* modules | 6 | | Core | | common datatypes | |
| 7 | * System.Torrent.* modules | 7 | | DHT | Core | centralized peer discovery | |
| 8 | | Tracker | Core | decentralized peer discovery | | ||
| 9 | | Exchange | Core | torrent content exchange | | ||
| 10 | | Client | any other | core of bittorrent client application | | ||
diff --git a/src/Readme.md b/src/Readme.md new file mode 100644 index 00000000..e092c3ad --- /dev/null +++ b/src/Readme.md | |||
| @@ -0,0 +1,8 @@ | |||
| 1 | Layout | ||
| 2 | ====== | ||
| 3 | |||
| 4 | | module group | can import | main purpose | | ||
| 5 | |:-------------|:----------------:|:-----------------------:| | ||
| 6 | | /Network | /Data & /System | peer and data exchange | | ||
| 7 | | /System | /Data | filesystem interface | | ||
| 8 | | /Data | | torrent metadata | | ||