From 410bb2715ce7c9f8d796704395cb44d76e2e884c Mon Sep 17 00:00:00 2001 From: gramanas Date: Tue, 23 Oct 2018 10:37:24 +0300 Subject: Add GNU kind communication guidelines --- README.html | 160 +++++++++++++++++++++++++++++++----------------------------- 1 file changed, 84 insertions(+), 76 deletions(-) (limited to 'README.html') diff --git a/README.html b/README.html index 9bbb656..7d71922 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,33 +305,41 @@ for the JavaScript code in this tag.
-
-

make

-
+
+

make

+
+

+Use -DCMAKE_INSTALL_PREFIX when running cmake to change the install path. +

# clone the repo
 > cd ~/code; git clone https://gitlab.com/grm-grm/ck
 # make a build directory and enter it
 > mkdir ~/ck_build; cd ~/ck_build;
 # run cmake
-> cmake ~/code/ck
+> cmake ~/code/ck 
 # run make
 > make
+# install it
+> make install
 # run ck
-> ./ck
+> ck
-
-

for devs

-
+
+

for devs

+
+

+Please be kind to each other. +

-
-

CMake options

-
+
+

CMake options

+

cmake accepts the following options:

@@ -371,9 +379,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 +390,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 +404,9 @@ go to the build directory and type:

-
-

test suite

-
+
+

test suite

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

-
-

Actions

-
+
+

Actions

+
-
-

init

-
+
+

init

+

or i or -i

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

add

-
+
+

add

+

or a or -a

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

list

-
+
+

list

+

or ls or l or -l

@@ -653,9 +661,9 @@ $ ck -l ckconf
-
-

search

-
+
+

search

+

or grep or s or -s

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

edit

-
+
+

edit

+

or e or -e

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

Created: 2018-10-19 Fri 13:06

+

Created: 2018-10-23 Tue 10:35

Validate

-- cgit v1.2.3