From fe781e5ae7116733e5b335a0ac016af97266db5f Mon Sep 17 00:00:00 2001 From: Anastasis Grammenos Date: Mon, 8 Oct 2018 23:47:07 +0300 Subject: Way better Edit --- README.html | 186 ++++++++++++++++++++++++++++++++++-------------------------- 1 file changed, 105 insertions(+), 81 deletions(-) (limited to 'README.html') diff --git a/README.html b/README.html index e51fc39..2180663 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,24 +382,25 @@ under unit/ directory and test the code.

-
-

run tests

-
+
+

run tests

+

-Simply go to the build dir and type. +First make sure you build ck with the -DCK_TESTS=1 option. Then +go to the build directory and type:

-
$ ./check_ck
+
$ ./test-ck
-
-

test suite

-
+
+

test suite

+
-
$ ./check_ck -h
+
$ ./test-ck -h
 ck test suite
 use without flags to run all tests
 
@@ -415,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 @@ -467,9 +468,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 +512,13 @@ $ ck -c /someplace/else ...

-
-

Actions

-
+
+

Actions

+
-
-

init

-
+
+

init

+

or i or -i

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

add

-
+
+

add

+

or a or -a

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

list

-
+
+

list

+

or ls or l or -l

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

search

-
+
+

search

+

or s or -s

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

edit

-
+
+

edit

+

or e or -e

-=--WIP--= +Edit configurations with $EDITOR.

-Currently edit can only edit the primary config of a program. +Edit takes at least one and up to two arguments.

-To do it use: +The first argument is the programName. If the program has a primary configuration +edit will open this. If the program has only one configuration edit will open it. +If the program has more than 1 configurations and no primary, it will print the +avaliable configurations and exit. +

+ +

+The second argument is the configName. If it exists it will open, else it will +print the avaliable configurations and exit. +

+ +

+Usage:

-
$ ck edit program_name
+
# suppose this is our ck instance
+$ ck list tree -a
+emacs:
+|- init.el
+|- accounts.el [s]
+|- orgconf.org [p]
+
+# edit the primary emacs config
+$ ck edit emacs
+
+# edit a specific emacs config, other than the primary
+$ ck edit emacs accounts.el
@@ -715,7 +739,7 @@ To do it use:
-

Created: 2018-10-07 Sun 16:25

+

Created: 2018-10-08 Mon 23:46

Validate

-- cgit v1.2.3