summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNathanaƫl Sensfelder <SpamShield0@MultiAgentSystems.org>2016-05-06 08:18:56 +0200
committerNathanaƫl Sensfelder <SpamShield0@MultiAgentSystems.org>2016-05-06 08:18:56 +0200
commitdc0c482a2146cb610a059bda5154762f5f782dca (patch)
tree45fc50bda0f6049682d7f95859c9efbe29ea895c
parent3405b0c1635843cbb81f042364bfcf238d7dc930 (diff)
Adds a basic README.
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e65cc75
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# zero-of-one
+(Yet another) Markov chain based IRC reply bot.
+
+## Dependencies
+- POSIX compliant OS.
+- C compiler (with C99 support).
+- CMake.
+
+## Quick setup guide
+```
+$ git clone https://github.com/nsensfel/zero-of-one
+$ cd zero-of-one
+$ mkdir build
+$ cd build
+$ cmake ..
+$ make
+$ ./zero_of_one -h
+```
+
+## Main Objectives
+- POSIX compliance.
+- Paranoia levels of error checking.
+- Low RAM usage.
+- Giggles.