aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNathanael Sensfelder <SpamShield0@MultiAgentSystems.org>2017-09-01 23:20:41 +0200
committerNathanael Sensfelder <SpamShield0@MultiAgentSystems.org>2017-09-01 23:20:41 +0200
commitb62d97800bfd2d6aafd75b5afc72c180d5241784 (patch)
tree946c6a116ce12777d2de19738a470a0dd360bba6
parent092615cdf57a1b230c793d08c9cab9ca62008415 (diff)
downloadcli-b62d97800bfd2d6aafd75b5afc72c180d5241784.zip
cli-b62d97800bfd2d6aafd75b5afc72c180d5241784.tar.bz2
Improves README (hopefully).
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
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.