From 5f25c80f19e24549eff60ee04576099d5dd2a5db Mon Sep 17 00:00:00 2001 From: Zlatin Balevsky Date: Sun, 15 Jul 2018 08:31:01 +0100 Subject: [PATCH] document pinger and host-cache subprojects --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 569c03b1..11223209 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +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. \ No newline at end of file