zzz/muwire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

document pinger and host-cache subprojects

Browse Source
This commit is contained in:
Zlatin Balevsky
2018-07-15 08:31:01 +01:00
parent 24f647020e
commit 5f25c80f19
1 changed files with 19 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -4,4 +4,22 @@ MuWire is an easy to use file-sharing program which offers anonymity using [I2P
It is inspired by the LimeWire Gnutella client and developped by a former LimeWire developer.
The project is in early planning stage. You can find technical documentation in the "doc" folder.
The project is in early planning stage. You can find technical documentation in the "doc" folder.
### Building
You need Gradle and a JDK 8 or newer. After installing those and setting up the appropriate paths, just type
```
gradle build
```
And that will build the "pinger" and "host-cache" sub-projects.
### Pinger sub-project
This is a simple command-line utility that sends a datagram with specified payload to a specified destination and prints out any responses
### Host-Cache sub-project
This is the bootstrap server (aka "HostCache") that MuWire uses. It listens for incoming Pings from MuWire nodes and responds with other nodes to connect to. In addition, it "crawls" the network to discover live nodes.