aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNathanael Sensfelder <SpamShield0@MultiAgentSystems.org>2017-09-01 23:13:14 +0200
committerNathanael Sensfelder <SpamShield0@MultiAgentSystems.org>2017-09-01 23:13:14 +0200
commitbed5bd98a6b92ae2fd7c274d8cdd38bd755372ae (patch)
treecc8b2cd2169616839730ed34c3ef4c8732689c35
parent2b1c103df8a566f1fee62a040da079a052cee83f (diff)
downloadmarkov-k-ram-bed5bd98a6b92ae2fd7c274d8cdd38bd755372ae.zip
markov-k-ram-bed5bd98a6b92ae2fd7c274d8cdd38bd755372ae.tar.bz2
Improves README (hopefully).
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
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``