From b62d97800bfd2d6aafd75b5afc72c180d5241784 Mon Sep 17 00:00:00 2001 From: Nathanael Sensfelder Date: Fri, 1 Sep 2017 23:20:41 +0200 Subject: Improves README (hopefully). --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 082987c..59c3c85 100644 --- a/README.md +++ b/README.md @@ -20,4 +20,17 @@ send. ## Dependencies - POSIX compliant OS. - C compiler (with C99 support). -- (GNU) make +- (GNU) make. + +## How to Build +* Download the source code. +* Enter the following command: ``$ make``. +* Run ``$ ./jh-cli`` to see how to use the binary. + +## Examples of Use +* Debug a JabberHive network by connecting to the socket ``/tmp/jh0``: + ``$ ./jh-cli /tmp/jh0``, then ``?RR what's up, doc?``. +* Teach a JabberHive network the content of some file through the socket + ``/tmp/jh0``: each line of the file should start by ``?RL ``, then it is + simply a case of ``$ cat file | ./jh-cli /tmp/jh0``. Cutting files so that + this can be run in parallel is recommended. -- cgit v1.2.3-70-g09d2