| summaryrefslogtreecommitdiff |
diff options
| author | Nathanael Sensfelder <SpamShield0@MultiAgentSystems.org> | 2017-09-01 23:11:02 +0200 |
|---|---|---|
| committer | Nathanael Sensfelder <SpamShield0@MultiAgentSystems.org> | 2017-09-01 23:11:02 +0200 |
| commit | 67b0da3889059d19a2b7b67840e2d89dc6ffda62 (patch) | |
| tree | db1ee5e5be3dda00ca1b106f8be5e15364b72d9c | |
| parent | b05361b3baa804a2c67e74dbd66828cb8517ed91 (diff) | |
Improves README (hopefully).
| -rw-r--r-- | README.md | 17 |
1 files changed, 15 insertions, 2 deletions
@@ -13,9 +13,22 @@ protocol for more information. * **Pipelining:** No. * **Behavior:** Gateway. - ## Dependencies - POSIX compliant OS. - C compiler (with C99 support). - (GNU) make. -- libircclient +- libircclient. + +## How to Build +* Download the source code. +* Enter the following command: ``$ make``. +* Run ``$ ./jh-cli`` to see how to use the binary. + +## Example of Use +* Create an IRC gateway that will connect to the JabberHive network through the + socket ``/tmp/lc0``, and to IRC on ``irc.foonetic.net``, port ``6667``, + with the nickname ``jabberhivebot``, channel ``#jabberhive``, with the + username ``JabberHive``, and the realname ``JabberHive IRC Gateway``; with + chat being printed to stdout: ``./jh-irc /tmp/lc0 "irc.foonetic.net" + "jabberhivebot" "#jabberhive" "6667" -u "JabberHive" -r + "JabberHive IRC Gateway" -c`` |


