From dc0c482a2146cb610a059bda5154762f5f782dca Mon Sep 17 00:00:00 2001 From: Nathanaƫl Sensfelder Date: Fri, 6 May 2016 08:18:56 +0200 Subject: Adds a basic README. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md 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. -- cgit v1.2.3-70-g09d2