From ab9e10f4387a1cf2a4419f7f20605e989f21d6a8 Mon Sep 17 00:00:00 2001 From: Zlatin Balevsky Date: Fri, 25 Oct 2019 17:43:15 +0100 Subject: [PATCH] add a note about the CLI --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ce58fcca..231a00fb 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ 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 current stable release - 0.5.2 is avaiable for download at https://muwire.com. You can find technical documentation in the "doc" folder. +The current stable release - 0.5.3 is avaiable for download at https://muwire.com. You can find technical documentation in the "doc" folder. ### Building @@ -21,7 +21,7 @@ If you want to run the unit tests, type If you want to build binary bundles that do not depend on Java or I2P, see the https://github.com/zlatinb/muwire-pkg project -### Running +### Running the GUI After you build the application, look inside `gui/build/distributions`. Untar/unzip one of the `shadow` files and then run the jar contained inside by typing `java -jar gui-x.y.z.jar` in a terminal or command prompt. @@ -29,6 +29,12 @@ If you have an I2P router running on the same machine that is all you need to do [Default I2CP port]\: `7654` +### Running the CLI + +Look inside `cli-lanterna/build/distributions`. Untar/unzip one of the `shadow` files and then run the jar contained inside by typing `java- jar cli-lanterna-x.y.z.jar` in a terminal. The CLI will ask you about the router host and port on startup, no need to edit any files. + +The CLI is under active development and doesn't have all the features of the GUI. + ### GPG Fingerprint ```