From bed5bd98a6b92ae2fd7c274d8cdd38bd755372ae Mon Sep 17 00:00:00 2001 From: Nathanael Sensfelder Date: Fri, 1 Sep 2017 23:13:14 +0200 Subject: Improves README (hopefully). --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 81411cd..dcac232 100644 --- a/README.md +++ b/README.md @@ -19,3 +19,12 @@ protocol for more information. - POSIX compliant OS. - C compiler (with C99 support). - (GNU) make. + +## How to Build +* Download the source code. +* Enter the following command: ``$ make``. +* Run ``$ ./jh-markov-k-ram`` to see how to use the binary. + +## Example of Use +* Create a server instance with a socket named ``/tmp/jh0`` and markov order of + 3: ``$ ./jabberhive-markov-k-ram /tmp/jh0 3`` -- cgit v1.2.3-70-g09d2