diff options
| author | Anastasis Grammenos <anastasis.gramm2@gmail.com> | 2018-10-07 16:25:33 +0300 |
|---|---|---|
| committer | Anastasis Grammenos <anastasis.gramm2@gmail.com> | 2018-10-07 16:25:33 +0300 |
| commit | 915fcc7dd6e55636aefd5998f6e2c273c2f48344 (patch) | |
| tree | 2d706bc55a7709d56d5198e9a9acd6762a84a877 | |
| parent | 5abff8c6661fd09180b0ec93cf4516d9993a1488 (diff) | |
| download | ck-915fcc7dd6e55636aefd5998f6e2c273c2f48344.tar.gz ck-915fcc7dd6e55636aefd5998f6e2c273c2f48344.tar.bz2 ck-915fcc7dd6e55636aefd5998f6e2c273c2f48344.zip | |
Update readme
| -rw-r--r-- | README.html | 150 | ||||
| -rw-r--r-- | 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"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <head> -<!-- 2018-09-28 Fri 23:23 --> +<!-- 2018-10-07 Sun 16:25 --> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <title>‎</title> @@ -232,35 +232,35 @@ for the JavaScript code in this tag. <h2>Table of Contents</h2> <div id="text-table-of-contents"> <ul> -<li><a href="#org1d54245">ck</a></li> -<li><a href="#org0f23886">build it</a> +<li><a href="#org84db86d">ck</a></li> +<li><a href="#org079cefd">build it</a> <ul> -<li><a href="#org633fb0e">requirements</a></li> -<li><a href="#org132a993">compiler</a></li> -<li><a href="#orgad56911">make</a></li> +<li><a href="#org309e80c">requirements</a></li> +<li><a href="#org41965f5">compiler</a></li> +<li><a href="#org6696ef0">make</a></li> </ul> </li> -<li><a href="#orgb2415b8">for devs</a> +<li><a href="#org06e00e7">for devs</a> <ul> -<li><a href="#orgfebd554">CMake options</a></li> -<li><a href="#orgba141a7">tests</a> +<li><a href="#orgcb6d6ca">CMake options</a></li> +<li><a href="#org73af3d7">tests</a> <ul> -<li><a href="#orgbdc8dd5">run tests</a></li> -<li><a href="#orgc178ae2">test suite</a></li> +<li><a href="#org792dc4d">run tests</a></li> +<li><a href="#orgac7c553">test suite</a></li> </ul> </li> </ul> </li> -<li><a href="#orgac988ad">manual</a> +<li><a href="#org52a2560">manual</a> <ul> -<li><a href="#org17fe919">ck configuration</a></li> -<li><a href="#orgeb1a91b">Actions</a> +<li><a href="#org09a0c5c">ck configuration</a></li> +<li><a href="#orgd61b3e4">Actions</a> <ul> -<li><a href="#orga34159d">init</a></li> -<li><a href="#orgfcddcc0">add</a></li> -<li><a href="#orgb841b44">list</a></li> -<li><a href="#org1acb8b9">search</a></li> -<li><a href="#org511c981">edit</a></li> +<li><a href="#org3ca7b35">init</a></li> +<li><a href="#orga12b072">add</a></li> +<li><a href="#orgab0f98c">list</a></li> +<li><a href="#orgdc0a7ed">search</a></li> +<li><a href="#orgd947583">edit</a></li> </ul> </li> </ul> @@ -269,22 +269,22 @@ for the JavaScript code in this tag. </div> </div> <p align="center"><img src="res/logo.png" width="30%" height="30%" /></p> -<div id="outline-container-org1d54245" class="outline-2"> -<h2 id="org1d54245">ck</h2> -<div class="outline-text-2" id="text-org1d54245"> +<div id="outline-container-org84db86d" class="outline-2"> +<h2 id="org84db86d">ck</h2> +<div class="outline-text-2" id="text-org84db86d"> <p> <b>The Config Keeper</b> </p> </div> </div> -<div id="outline-container-org0f23886" class="outline-2"> -<h2 id="org0f23886">build it</h2> -<div class="outline-text-2" id="text-org0f23886"> +<div id="outline-container-org079cefd" class="outline-2"> +<h2 id="org079cefd">build it</h2> +<div class="outline-text-2" id="text-org079cefd"> </div> -<div id="outline-container-org633fb0e" class="outline-3"> -<h3 id="org633fb0e">requirements</h3> -<div class="outline-text-3" id="text-org633fb0e"> +<div id="outline-container-org309e80c" class="outline-3"> +<h3 id="org309e80c">requirements</h3> +<div class="outline-text-3" id="text-org309e80c"> <ul class="org-ul"> <li>clang (llvm) or gcc (gnu)</li> <li>cmake</li> @@ -293,9 +293,9 @@ for the JavaScript code in this tag. </div> </div> -<div id="outline-container-org132a993" class="outline-3"> -<h3 id="org132a993">compiler</h3> -<div class="outline-text-3" id="text-org132a993"> +<div id="outline-container-org41965f5" class="outline-3"> +<h3 id="org41965f5">compiler</h3> +<div class="outline-text-3" id="text-org41965f5"> <div class="org-src-container"> <pre class="src src-sh">> export <span style="color: #ffac4a;">CC</span>=clang <span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">or</span> @@ -305,9 +305,9 @@ for the JavaScript code in this tag. </div> </div> -<div id="outline-container-orgad56911" class="outline-3"> -<h3 id="orgad56911">make</h3> -<div class="outline-text-3" id="text-orgad56911"> +<div id="outline-container-org6696ef0" class="outline-3"> +<h3 id="org6696ef0">make</h3> +<div class="outline-text-3" id="text-org6696ef0"> <div class="org-src-container"> <pre class="src src-sh"><span style="color: #6A6D70;"># </span><span style="color: #6A6D70;">clone the repo</span> > cd ~/code; git clone https://gitlab.com/grm-grm/ck @@ -325,13 +325,13 @@ for the JavaScript code in this tag. </div> </div> -<div id="outline-container-orgb2415b8" class="outline-2"> -<h2 id="orgb2415b8">for devs</h2> -<div class="outline-text-2" id="text-orgb2415b8"> +<div id="outline-container-org06e00e7" class="outline-2"> +<h2 id="org06e00e7">for devs</h2> +<div class="outline-text-2" id="text-org06e00e7"> </div> -<div id="outline-container-orgfebd554" class="outline-3"> -<h3 id="orgfebd554">CMake options</h3> -<div class="outline-text-3" id="text-orgfebd554"> +<div id="outline-container-orgcb6d6ca" class="outline-3"> +<h3 id="orgcb6d6ca">CMake options</h3> +<div class="outline-text-3" id="text-orgcb6d6ca"> <p> cmake accepts the following options: </p> @@ -371,9 +371,9 @@ llvm has better asan than gcc, so I use that. </div> </div> -<div id="outline-container-orgba141a7" class="outline-3"> -<h3 id="orgba141a7">tests</h3> -<div class="outline-text-3" id="text-orgba141a7"> +<div id="outline-container-org73af3d7" class="outline-3"> +<h3 id="org73af3d7">tests</h3> +<div class="outline-text-3" id="text-org73af3d7"> <p> The testing "suite" is a bash script that runs regression and unit tests. Regression tests are under the <code>tests/</code> directory @@ -382,9 +382,9 @@ under <code>unit/</code> directory and test the code. </p> </div> -<div id="outline-container-orgbdc8dd5" class="outline-4"> -<h4 id="orgbdc8dd5">run tests</h4> -<div class="outline-text-4" id="text-orgbdc8dd5"> +<div id="outline-container-org792dc4d" class="outline-4"> +<h4 id="org792dc4d">run tests</h4> +<div class="outline-text-4" id="text-org792dc4d"> <p> Simply go to the build dir and type. </p> @@ -395,9 +395,9 @@ Simply go to the build dir and type. </div> </div> -<div id="outline-container-orgc178ae2" class="outline-4"> -<h4 id="orgc178ae2">test suite</h4> -<div class="outline-text-4" id="text-orgc178ae2"> +<div id="outline-container-orgac7c553" class="outline-4"> +<h4 id="orgac7c553">test suite</h4> +<div class="outline-text-4" id="text-orgac7c553"> <div class="org-src-container"> <pre class="src src-sh">$ ./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 </pre> </div> @@ -415,9 +415,9 @@ flags: </div> </div> </div> -<div id="outline-container-orgac988ad" class="outline-2"> -<h2 id="orgac988ad">manual</h2> -<div class="outline-text-2" id="text-orgac988ad"> +<div id="outline-container-org52a2560" class="outline-2"> +<h2 id="org52a2560">manual</h2> +<div class="outline-text-2" id="text-org52a2560"> <p> 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. </p> </div> -<div id="outline-container-org17fe919" class="outline-3"> -<h3 id="org17fe919">ck configuration</h3> -<div class="outline-text-3" id="text-org17fe919"> +<div id="outline-container-org09a0c5c" class="outline-3"> +<h3 id="org09a0c5c">ck configuration</h3> +<div class="outline-text-3" id="text-org09a0c5c"> <p> ck uses sqlite to index the configuration files. The init action creates a <b>.ck</b> directory (under $HOME) @@ -511,13 +511,13 @@ $ ck -c /someplace/else ... </div> </div> -<div id="outline-container-orgeb1a91b" class="outline-3"> -<h3 id="orgeb1a91b">Actions</h3> -<div class="outline-text-3" id="text-orgeb1a91b"> +<div id="outline-container-orgd61b3e4" class="outline-3"> +<h3 id="orgd61b3e4">Actions</h3> +<div class="outline-text-3" id="text-orgd61b3e4"> </div> -<div id="outline-container-orga34159d" class="outline-4"> -<h4 id="orga34159d">init</h4> -<div class="outline-text-4" id="text-orga34159d"> +<div id="outline-container-org3ca7b35" class="outline-4"> +<h4 id="org3ca7b35">init</h4> +<div class="outline-text-4" id="text-org3ca7b35"> <p> or i or -i </p> @@ -547,9 +547,9 @@ $ ck init /path_to/where_you_want/your_configs/to_be <span style="color: #E6DB74 </div> </div> -<div id="outline-container-orgfcddcc0" class="outline-4"> -<h4 id="orgfcddcc0">add</h4> -<div class="outline-text-4" id="text-orgfcddcc0"> +<div id="outline-container-orga12b072" class="outline-4"> +<h4 id="orga12b072">add</h4> +<div class="outline-text-4" id="text-orga12b072"> <p> or a or -a </p> @@ -590,9 +590,9 @@ $ ck add program_name config_path [-s] [-p] </div> </div> -<div id="outline-container-orgb841b44" class="outline-4"> -<h4 id="orgb841b44">list</h4> -<div class="outline-text-4" id="text-orgb841b44"> +<div id="outline-container-orgab0f98c" class="outline-4"> +<h4 id="orgab0f98c">list</h4> +<div class="outline-text-4" id="text-orgab0f98c"> <p> or ls or l or -l </p> @@ -636,9 +636,9 @@ $ ck ls programs -t lisp </div> </div> -<div id="outline-container-org1acb8b9" class="outline-4"> -<h4 id="org1acb8b9">search</h4> -<div class="outline-text-4" id="text-org1acb8b9"> +<div id="outline-container-orgdc0a7ed" class="outline-4"> +<h4 id="orgdc0a7ed">search</h4> +<div class="outline-text-4" id="text-orgdc0a7ed"> <p> or s or -s </p> @@ -687,9 +687,9 @@ $ for i ($(ck ls paths)) grep -E <span style="color: #E6DB74;">'A|B'</span> $<sp </div> </div> -<div id="outline-container-org511c981" class="outline-4"> -<h4 id="org511c981">edit</h4> -<div class="outline-text-4" id="text-org511c981"> +<div id="outline-container-orgd947583" class="outline-4"> +<h4 id="orgd947583">edit</h4> +<div class="outline-text-4" id="text-orgd947583"> <p> or e or -e </p> @@ -715,7 +715,7 @@ To do it use: </div> </div> <div id="postamble" class="status"> -<p class="date">Created: 2018-09-28 Fri 23:23</p> +<p class="date">Created: 2018-10-07 Sun 16:25</p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> </div> </body> @@ -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 |