diff options
| author | gramanas <anastasis.gramm2@gmail.com> | 2018-10-23 10:37:24 +0300 |
|---|---|---|
| committer | gramanas <anastasis.gramm2@gmail.com> | 2018-10-23 10:37:24 +0300 |
| commit | 410bb2715ce7c9f8d796704395cb44d76e2e884c (patch) | |
| tree | d326390ee443d48e36e7f1c0c2b6ff9b96a7c042 /README.html | |
| parent | 6169275c8b318f99672fca00b48d61680ef91804 (diff) | |
| download | ck-410bb2715ce7c9f8d796704395cb44d76e2e884c.tar.gz ck-410bb2715ce7c9f8d796704395cb44d76e2e884c.tar.bz2 ck-410bb2715ce7c9f8d796704395cb44d76e2e884c.zip | |
Add GNU kind communication guidelines
Diffstat (limited to 'README.html')
| -rw-r--r-- | README.html | 160 |
1 files changed, 84 insertions, 76 deletions
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"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <head> -<!-- 2018-10-19 Fri 13:06 --> +<!-- 2018-10-23 Tue 10:35 --> <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="#orgfda6b85">ck</a></li> -<li><a href="#org81f18da">build it</a> +<li><a href="#org188eec0">ck</a></li> +<li><a href="#org5cf05fb">build it</a> <ul> -<li><a href="#orgca5f041">requirements</a></li> -<li><a href="#org42b1074">compiler</a></li> -<li><a href="#org3c16cc6">make</a></li> +<li><a href="#orgddaa24b">requirements</a></li> +<li><a href="#org4b2326a">compiler</a></li> +<li><a href="#orgcc546ab">make</a></li> </ul> </li> -<li><a href="#orgb5f4d41">for devs</a> +<li><a href="#org8c57e12">for devs</a> <ul> -<li><a href="#org359975d">CMake options</a></li> -<li><a href="#org2d42457">tests</a> +<li><a href="#org6c910a6">CMake options</a></li> +<li><a href="#org9be5ed3">tests</a> <ul> -<li><a href="#org14b5d19">run tests</a></li> -<li><a href="#org4539733">test suite</a></li> +<li><a href="#orgbe86272">run tests</a></li> +<li><a href="#org136123c">test suite</a></li> </ul> </li> </ul> </li> -<li><a href="#org9c9d0fe">manual</a> +<li><a href="#org1b4ae92">manual</a> <ul> -<li><a href="#orgbcee4b6">ck configuration</a></li> -<li><a href="#org67f2600">Actions</a> +<li><a href="#org028f12c">ck configuration</a></li> +<li><a href="#org675d6b6">Actions</a> <ul> -<li><a href="#org85fb98c">init</a></li> -<li><a href="#org139047f">add</a></li> -<li><a href="#org2c7f2ea">list</a></li> -<li><a href="#orge8ba31a">search</a></li> -<li><a href="#org6d1d447">edit</a></li> +<li><a href="#orgd421244">init</a></li> +<li><a href="#org400c289">add</a></li> +<li><a href="#orgab0ce16">list</a></li> +<li><a href="#orgb29e969">search</a></li> +<li><a href="#orgd0ea024">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"></p> -<div id="outline-container-orgfda6b85" class="outline-2"> -<h2 id="orgfda6b85">ck</h2> -<div class="outline-text-2" id="text-orgfda6b85"> +<div id="outline-container-org188eec0" class="outline-2"> +<h2 id="org188eec0">ck</h2> +<div class="outline-text-2" id="text-org188eec0"> <p> <b>The Config Keeper</b> </p> </div> </div> -<div id="outline-container-org81f18da" class="outline-2"> -<h2 id="org81f18da">build it</h2> -<div class="outline-text-2" id="text-org81f18da"> +<div id="outline-container-org5cf05fb" class="outline-2"> +<h2 id="org5cf05fb">build it</h2> +<div class="outline-text-2" id="text-org5cf05fb"> </div> -<div id="outline-container-orgca5f041" class="outline-3"> -<h3 id="orgca5f041">requirements</h3> -<div class="outline-text-3" id="text-orgca5f041"> +<div id="outline-container-orgddaa24b" class="outline-3"> +<h3 id="orgddaa24b">requirements</h3> +<div class="outline-text-3" id="text-orgddaa24b"> <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-org42b1074" class="outline-3"> -<h3 id="org42b1074">compiler</h3> -<div class="outline-text-3" id="text-org42b1074"> +<div id="outline-container-org4b2326a" class="outline-3"> +<h3 id="org4b2326a">compiler</h3> +<div class="outline-text-3" id="text-org4b2326a"> <div class="org-src-container"> <pre class="src src-sh">> export <span style="color: #baba36;">CC</span>=clang <span style="color: #656565;"># </span><span style="color: #757575;">or</span> @@ -305,33 +305,41 @@ for the JavaScript code in this tag. </div> </div> -<div id="outline-container-org3c16cc6" class="outline-3"> -<h3 id="org3c16cc6">make</h3> -<div class="outline-text-3" id="text-org3c16cc6"> +<div id="outline-container-orgcc546ab" class="outline-3"> +<h3 id="orgcc546ab">make</h3> +<div class="outline-text-3" id="text-orgcc546ab"> +<p> +Use <code>-DCMAKE_INSTALL_PREFIX</code> when running cmake to change the install path. +</p> <div class="org-src-container"> <pre class="src src-sh"><span style="color: #656565;"># </span><span style="color: #757575;">clone the repo</span> > cd ~/code; git clone https://gitlab.com/grm-grm/ck <span style="color: #656565;"># </span><span style="color: #757575;">make a build directory and enter it</span> > mkdir ~/ck_build; <span style="color: #528fd1;">cd</span> ~/ck_build; <span style="color: #656565;"># </span><span style="color: #757575;">run cmake</span> -> cmake ~/code/ck +> cmake ~/code/ck <span style="color: #656565;"># </span><span style="color: #757575;">run make</span> > make +<span style="color: #656565;"># </span><span style="color: #757575;">install it</span> +> make install <span style="color: #656565;"># </span><span style="color: #757575;">run ck</span> -> ./ck +> ck </pre> </div> </div> </div> </div> -<div id="outline-container-orgb5f4d41" class="outline-2"> -<h2 id="orgb5f4d41">for devs</h2> -<div class="outline-text-2" id="text-orgb5f4d41"> +<div id="outline-container-org8c57e12" class="outline-2"> +<h2 id="org8c57e12">for devs</h2> +<div class="outline-text-2" id="text-org8c57e12"> +<p> +Please be <a href="https://www.gnu.org/philosophy/kind-communication.html">kind</a> to each other. +</p> </div> -<div id="outline-container-org359975d" class="outline-3"> -<h3 id="org359975d">CMake options</h3> -<div class="outline-text-3" id="text-org359975d"> +<div id="outline-container-org6c910a6" class="outline-3"> +<h3 id="org6c910a6">CMake options</h3> +<div class="outline-text-3" id="text-org6c910a6"> <p> cmake accepts the following options: </p> @@ -371,9 +379,9 @@ llvm has better asan than gcc, so I use that. </div> </div> -<div id="outline-container-org2d42457" class="outline-3"> -<h3 id="org2d42457">tests</h3> -<div class="outline-text-3" id="text-org2d42457"> +<div id="outline-container-org9be5ed3" class="outline-3"> +<h3 id="org9be5ed3">tests</h3> +<div class="outline-text-3" id="text-org9be5ed3"> <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 +390,9 @@ under <code>unit/</code> directory and test the code. </p> </div> -<div id="outline-container-org14b5d19" class="outline-4"> -<h4 id="org14b5d19">run tests</h4> -<div class="outline-text-4" id="text-org14b5d19"> +<div id="outline-container-orgbe86272" class="outline-4"> +<h4 id="orgbe86272">run tests</h4> +<div class="outline-text-4" id="text-orgbe86272"> <p> First make sure you build ck with the <code>-DCK_TESTS=1</code> option. Then go to the build directory and type: @@ -396,9 +404,9 @@ go to the build directory and type: </div> </div> -<div id="outline-container-org4539733" class="outline-4"> -<h4 id="org4539733">test suite</h4> -<div class="outline-text-4" id="text-org4539733"> +<div id="outline-container-org136123c" class="outline-4"> +<h4 id="org136123c">test suite</h4> +<div class="outline-text-4" id="text-org136123c"> <div class="org-src-container"> <pre class="src src-sh">$ ./test-ck -h ck test suite @@ -416,9 +424,9 @@ flags: </div> </div> </div> -<div id="outline-container-org9c9d0fe" class="outline-2"> -<h2 id="org9c9d0fe">manual</h2> -<div class="outline-text-2" id="text-org9c9d0fe"> +<div id="outline-container-org1b4ae92" class="outline-2"> +<h2 id="org1b4ae92">manual</h2> +<div class="outline-text-2" id="text-org1b4ae92"> <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 @@ -469,9 +477,9 @@ of flags one has to pass to ck. </p> </div> -<div id="outline-container-orgbcee4b6" class="outline-3"> -<h3 id="orgbcee4b6">ck configuration</h3> -<div class="outline-text-3" id="text-orgbcee4b6"> +<div id="outline-container-org028f12c" class="outline-3"> +<h3 id="org028f12c">ck configuration</h3> +<div class="outline-text-3" id="text-org028f12c"> <p> ck uses sqlite to index the configuration files. The init action creates a <b>.ck</b> directory (under $HOME) @@ -509,13 +517,13 @@ $ ck -c /someplace/else ... </div> </div> -<div id="outline-container-org67f2600" class="outline-3"> -<h3 id="org67f2600">Actions</h3> -<div class="outline-text-3" id="text-org67f2600"> +<div id="outline-container-org675d6b6" class="outline-3"> +<h3 id="org675d6b6">Actions</h3> +<div class="outline-text-3" id="text-org675d6b6"> </div> -<div id="outline-container-org85fb98c" class="outline-4"> -<h4 id="org85fb98c">init</h4> -<div class="outline-text-4" id="text-org85fb98c"> +<div id="outline-container-orgd421244" class="outline-4"> +<h4 id="orgd421244">init</h4> +<div class="outline-text-4" id="text-orgd421244"> <p> or i or -i </p> @@ -545,9 +553,9 @@ $ ck init /path_to/where_you_want/your_configs/to_be <span style="color: #bdbc61 </div> </div> -<div id="outline-container-org139047f" class="outline-4"> -<h4 id="org139047f">add</h4> -<div class="outline-text-4" id="text-org139047f"> +<div id="outline-container-org400c289" class="outline-4"> +<h4 id="org400c289">add</h4> +<div class="outline-text-4" id="text-org400c289"> <p> or a or -a </p> @@ -588,9 +596,9 @@ $ ck add program_name config_path [-s] [-p] </div> </div> -<div id="outline-container-org2c7f2ea" class="outline-4"> -<h4 id="org2c7f2ea">list</h4> -<div class="outline-text-4" id="text-org2c7f2ea"> +<div id="outline-container-orgab0ce16" class="outline-4"> +<h4 id="orgab0ce16">list</h4> +<div class="outline-text-4" id="text-orgab0ce16"> <p> or ls or l or -l </p> @@ -653,9 +661,9 @@ $ ck -l ckconf </div> </div> -<div id="outline-container-orge8ba31a" class="outline-4"> -<h4 id="orge8ba31a">search</h4> -<div class="outline-text-4" id="text-orge8ba31a"> +<div id="outline-container-orgb29e969" class="outline-4"> +<h4 id="orgb29e969">search</h4> +<div class="outline-text-4" id="text-orgb29e969"> <p> or grep or s or -s </p> @@ -704,9 +712,9 @@ $ for i ($(ck ls paths)) grep -E <span style="color: #bdbc61;">'A|B'</span> $<sp </div> </div> -<div id="outline-container-org6d1d447" class="outline-4"> -<h4 id="org6d1d447">edit</h4> -<div class="outline-text-4" id="text-org6d1d447"> +<div id="outline-container-orgd0ea024" class="outline-4"> +<h4 id="orgd0ea024">edit</h4> +<div class="outline-text-4" id="text-orgd0ea024"> <p> or e or -e </p> @@ -755,7 +763,7 @@ $ ck edit emacs accounts.el </div> </div> <div id="postamble" class="status"> -<p class="date">Created: 2018-10-19 Fri 13:06</p> +<p class="date">Created: 2018-10-23 Tue 10:35</p> <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p> </div> </body> |