From 8755b4dc440e842b4cc45375e07aff3236cf5768 Mon Sep 17 00:00:00 2001
From: gramanas <anastasis.gramm2@gmail.com>
Date: Sun, 15 Apr 2018 03:31:27 +0300
Subject: update readme

---
 README.org | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

(limited to 'README.org')

diff --git a/README.org b/README.org
index 8fe4d08..e0555a7 100644
--- a/README.org
+++ b/README.org
@@ -1,4 +1,29 @@
 * ck
 ** The Config Keeper
 
-Under heavy development
+* build it
+** requirements
+- gcc
+- cmake
+- sqlite3-dev
+
+** make
+#+BEGIN_SRC sh
+# clone the repo
+> cd ~/code; git clone https://github.com/gramanas/ck
+# make a build directory and enter it
+> mkdir ~/ck_build; cd ~/ck_build;
+# run cmake
+> cmake ~/code/ck
+# run make
+> make
+#+END_SRC
+
+** run the tests
+Simply go to the build dir and type.
+
+*WARNING!* This will destroy any configurations or databases
+you might have. (for now)
+#+BEGIN_SRC sh
+./test_ck
+#+END_SRC
-- 
cgit v1.2.3