| summaryrefslogtreecommitdiff |
diff options
Diffstat (limited to 'README.md')
| -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`` |