From 915fcc7dd6e55636aefd5998f6e2c273c2f48344 Mon Sep 17 00:00:00 2001 From: Anastasis Grammenos Date: Sun, 7 Oct 2018 16:25:33 +0300 Subject: Update readme --- README.html | 150 ++++++++++++++++++++++++++++++------------------------------ README.org | 2 +- 2 files changed, 76 insertions(+), 76 deletions(-) diff --git a/README.html b/README.html index a1f67cd..e51fc39 100644 --- a/README.html +++ b/README.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + ‎ @@ -232,35 +232,35 @@ for the JavaScript code in this tag.

Table of Contents

-
-

ck

-
+
+

ck

+

The Config Keeper

-
-

build it

-
+
+

build it

+
-
-

requirements

-
+
+

requirements

+
  • clang (llvm) or gcc (gnu)
  • cmake
    • @@ -293,9 +293,9 @@ for the JavaScript code in this tag.
-
-

compiler

-
+
+

compiler

+
> export CC=clang
 # or
@@ -305,9 +305,9 @@ for the JavaScript code in this tag.
-
-

make

-
+
+

make

+
# clone the repo
 > cd ~/code; git clone https://gitlab.com/grm-grm/ck
@@ -325,13 +325,13 @@ for the JavaScript code in this tag.
-
-

for devs

-
+
+

for devs

+
-
-

CMake options

-
+
+

CMake options

+

cmake accepts the following options:

@@ -371,9 +371,9 @@ llvm has better asan than gcc, so I use that.
-
-

tests

-
+
+

tests

+

The testing "suite" is a bash script that runs regression and unit tests. Regression tests are under the tests/ directory @@ -382,9 +382,9 @@ under unit/ directory and test the code.

-
-

run tests

-
+
+

run tests

+

Simply go to the build dir and type.

@@ -395,9 +395,9 @@ Simply go to the build dir and type.
-
-

test suite

-
+
+

test suite

+
$ ./check_ck -h
 ck test suite
@@ -407,7 +407,7 @@ flags:
   -u, --unit            run only the unit tests
   -r, --regression      run only the regression tests
   -c, --clear           remove test files
-                         use it if the tests fail
+                         use if the tests crush unexpectedly
   -h, --help, *         print this
@@ -415,9 +415,9 @@ flags:
-
-

manual

-
+
+

manual

+

ck's goal is to assist with the configuration file management. To that end it tries to provides a cli interface that is pretty straight-forward @@ -467,9 +467,9 @@ of flags one has to pass to ck.

-
-

ck configuration

-
+
+

ck configuration

+

ck uses sqlite to index the configuration files. The init action creates a .ck directory (under $HOME) @@ -511,13 +511,13 @@ $ ck -c /someplace/else ...

-
-

Actions

-
+
+

Actions

+
-
-

init

-
+
+

init

+

or i or -i

@@ -547,9 +547,9 @@ $ ck init /path_to/where_you_want/your_configs/to_be -

add

-
+
+

add

+

or a or -a

@@ -590,9 +590,9 @@ $ ck add program_name config_path [-s] [-p]
-
-

list

-
+
+

list

+

or ls or l or -l

@@ -636,9 +636,9 @@ $ ck ls programs -t lisp
-
-

search

-
+
+

search

+

or s or -s

@@ -687,9 +687,9 @@ $ for i ($(ck ls paths)) grep -E 'A|B' $
-
-

edit

-
+
+

edit

+

or e or -e

@@ -715,7 +715,7 @@ To do it use:
-

Created: 2018-09-28 Fri 23:23

+

Created: 2018-10-07 Sun 16:25

Validate

diff --git a/README.org b/README.org index 004ea2e..13c126e 100644 --- a/README.org +++ b/README.org @@ -82,7 +82,7 @@ flags: -u, --unit run only the unit tests -r, --regression run only the regression tests -c, --clear remove test files - use it if the tests fail + use if the tests crush unexpectedly -h, --help, * print this #+END_SRC * manual -- cgit v1.2.3