From 67b0da3889059d19a2b7b67840e2d89dc6ffda62 Mon Sep 17 00:00:00 2001 From: Nathanael Sensfelder Date: Fri, 1 Sep 2017 23:11:02 +0200 Subject: Improves README (hopefully). --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 22b126b..54a5e7c 100644 --- a/README.md +++ b/README.md @@ -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`` -- cgit v1.2.3-70-g09d2