commit 5869f765b075dbdeaa88b62de1a836053bceb687
parent d4386195da1c2105d05b53844a3fa4edeab482c3
Author: Joris Vink <joris@coders.se>
Date: Thu, 3 Jul 2014 22:40:12 +0200
Update with more instructions
Diffstat:
README.md | 41 +++++++++++++++++++++++++++++++++++++++++
1 file changed, 41 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -37,6 +37,47 @@ Releases
--------
* [2014-03-01] Version 1.1 - https://kore.io/release/kore-1.1-stable.tgz
+Building Kore
+-------------
+
+Requirements
+* libz
+* openssl >= 1.0.1g
+
+Requirements for background tasks:
+* pthreads
+
+Requirements for pgsql:
+* libpq
+
+Normal compilation and installation:
+
+```
+# git clone https://github.com/jorisvink/kore.git
+# cd kore
+# make
+# make install
+```
+
+If you would like to build a specific flavor, you can enable
+those by setting a shell environment variable before running **_make_**.
+
+* TASKS=1 (compiles in task support)
+* PGSQL=1 (compiles in pgsql support)
+* DEBUG=1 (enables use of -d for debug)
+* KORE_PEDANTIC_MALLOC=1 (zero all allocated memory)
+
+Example libraries
+-----------------
+
+You can find example libraries under **_contrib/examples/_**.
+
+The examples should be compiled using the supplied **build.sh** scripts
+and assume you have installed the header files using make install.
+
+I apologize for unclear examples or documentation, I am working on
+improving those. In the mean time feel free to jump in and help out!
+
Bugs, contributions and more
----------------------------