From 480a42d85b702e42bef95d2c38adfcf2964a1f11 Mon Sep 17 00:00:00 2001 From: gramanas Date: Sun, 14 Oct 2018 15:34:50 +0300 Subject: logo --- README.html | 150 ++++++++++++++++++++++++++++++------------------------------ README.org | 2 +- 2 files changed, 76 insertions(+), 76 deletions(-) diff --git a/README.html b/README.html index 4ebb066..43d1e52 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

+

First make sure you build ck with the -DCK_TESTS=1 option. Then go to the build directory and type: @@ -396,9 +396,9 @@ go to the build directory and type:

-
-

test suite

-
+
+

test suite

+
$ ./test-ck -h
 ck test suite
@@ -416,9 +416,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 @@ -469,9 +469,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) @@ -513,13 +513,13 @@ $ ck -c /someplace/else ...

-
-

Actions

-
+
+

Actions

+
-
-

init

-
+
+

init

+

or i or -i

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

add

-
+
+

add

+

or a or -a

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

list

-
+
+

list

+

or ls or l or -l

@@ -657,9 +657,9 @@ $ ck -l ckconf
-
-

search

-
+
+

search

+

or grep or s or -s

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

edit

-
+
+

edit

+

or e or -e

@@ -759,7 +759,7 @@ $ ck edit emacs accounts.el
-

Created: 2018-10-09 Tue 20:56

+

Created: 2018-10-14 Sun 15:34

Validate

diff --git a/README.org b/README.org index 4f4fc52..b7da351 100644 --- a/README.org +++ b/README.org @@ -1,5 +1,5 @@ #+OPTIONS: ^:nil num:nil -#+html:

+#+html:

* ck *The Config Keeper* -- cgit v1.2.3