aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgramanas <anastasis.gramm2@gmail.com>2018-04-15 03:31:27 +0300
committergramanas <anastasis.gramm2@gmail.com>2018-04-15 03:31:27 +0300
commit8755b4dc440e842b4cc45375e07aff3236cf5768 (patch)
treea3728127685f5a9a35423e03749fdab13e42ffd2
parentac34419be8a56d86a395a6ef0ce86c89b25ddd55 (diff)
downloadck-8755b4dc440e842b4cc45375e07aff3236cf5768.tar.gz
ck-8755b4dc440e842b4cc45375e07aff3236cf5768.tar.bz2
ck-8755b4dc440e842b4cc45375e07aff3236cf5768.zip
update readme
-rw-r--r--README.org27
1 files changed, 26 insertions, 1 deletions
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