Add markdown readme

author: gramanas <anastasis.gramm2@gmail.com> 2018-09-20 20:22:21 +0300
committer: gramanas <anastasis.gramm2@gmail.com> 2018-09-20 20:25:14 +0300
commit: e9d38489372de572cfdb4f7f187957ecd8a0c706 (patch)
tree: 248a78c7177727ea7d7908f4fb15c05405adf4d6 /README.html
parent: 8693064200ad015a6b6d07f99a3170fa89012a71 (diff)
download: ck-e9d38489372de572cfdb4f7f187957ecd8a0c706.tar.gz
ck-e9d38489372de572cfdb4f7f187957ecd8a0c706.tar.bz2
ck-e9d38489372de572cfdb4f7f187957ecd8a0c706.zip
1 files changed, 389 insertions, 0 deletions
diff --git a/README.html b/README.html
new file mode 100644
index 0000000..227c7f6
--- /dev/null
+++ b/README.html
@@ -0,0 +1,389 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"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-20 Thu 20:23 -->
+<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+<meta name="viewport" content="width=device-width, initial-scale=1" />
+<title>&lrm;</title>
+<meta name="generator" content="Org mode" />
+<style type="text/css">
+ <!--/*--><![CDATA[/*><!--*/
+  .title  { text-align: center;
+             margin-bottom: .2em; }
+  .subtitle { text-align: center;
+              font-size: medium;
+              font-weight: bold;
+              margin-top:0; }
+  .todo   { font-family: monospace; color: red; }
+  .done   { font-family: monospace; color: green; }
+  .priority { font-family: monospace; color: orange; }
+  .tag    { background-color: #eee; font-family: monospace;
+            padding: 2px; font-size: 80%; font-weight: normal; }
+  .timestamp { color: #bebebe; }
+  .timestamp-kwd { color: #5f9ea0; }
+  .org-right  { margin-left: auto; margin-right: 0px;  text-align: right; }
+  .org-left   { margin-left: 0px;  margin-right: auto; text-align: left; }
+  .org-center { margin-left: auto; margin-right: auto; text-align: center; }
+  .underline { text-decoration: underline; }
+  #postamble p, #preamble p { font-size: 90%; margin: .2em; }
+  p.verse { margin-left: 3%; }
+  pre {
+    border: 1px solid #ccc;
+    box-shadow: 3px 3px 3px #eee;
+    padding: 8pt;
+    font-family: monospace;
+    overflow: auto;
+    margin: 1.2em;
+  }
+  pre.src {
+    position: relative;
+    overflow: visible;
+    padding-top: 1.2em;
+  }
+  pre.src:before {
+    display: none;
+    position: absolute;
+    background-color: white;
+    top: -10px;
+    right: 10px;
+    padding: 3px;
+    border: 1px solid black;
+  }
+  pre.src:hover:before { display: inline;}
+  /* Languages per Org manual */
+  pre.src-asymptote:before { content: 'Asymptote'; }
+  pre.src-awk:before { content: 'Awk'; }
+  pre.src-C:before { content: 'C'; }
+  /* pre.src-C++ doesn't work in CSS */
+  pre.src-clojure:before { content: 'Clojure'; }
+  pre.src-css:before { content: 'CSS'; }
+  pre.src-D:before { content: 'D'; }
+  pre.src-ditaa:before { content: 'ditaa'; }
+  pre.src-dot:before { content: 'Graphviz'; }
+  pre.src-calc:before { content: 'Emacs Calc'; }
+  pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
+  pre.src-fortran:before { content: 'Fortran'; }
+  pre.src-gnuplot:before { content: 'gnuplot'; }
+  pre.src-haskell:before { content: 'Haskell'; }
+  pre.src-hledger:before { content: 'hledger'; }
+  pre.src-java:before { content: 'Java'; }
+  pre.src-js:before { content: 'Javascript'; }
+  pre.src-latex:before { content: 'LaTeX'; }
+  pre.src-ledger:before { content: 'Ledger'; }
+  pre.src-lisp:before { content: 'Lisp'; }
+  pre.src-lilypond:before { content: 'Lilypond'; }
+  pre.src-lua:before { content: 'Lua'; }
+  pre.src-matlab:before { content: 'MATLAB'; }
+  pre.src-mscgen:before { content: 'Mscgen'; }
+  pre.src-ocaml:before { content: 'Objective Caml'; }
+  pre.src-octave:before { content: 'Octave'; }
+  pre.src-org:before { content: 'Org mode'; }
+  pre.src-oz:before { content: 'OZ'; }
+  pre.src-plantuml:before { content: 'Plantuml'; }
+  pre.src-processing:before { content: 'Processing.js'; }
+  pre.src-python:before { content: 'Python'; }
+  pre.src-R:before { content: 'R'; }
+  pre.src-ruby:before { content: 'Ruby'; }
+  pre.src-sass:before { content: 'Sass'; }
+  pre.src-scheme:before { content: 'Scheme'; }
+  pre.src-screen:before { content: 'Gnu Screen'; }
+  pre.src-sed:before { content: 'Sed'; }
+  pre.src-sh:before { content: 'shell'; }
+  pre.src-sql:before { content: 'SQL'; }
+  pre.src-sqlite:before { content: 'SQLite'; }
+  /* additional languages in org.el's org-babel-load-languages alist */
+  pre.src-forth:before { content: 'Forth'; }
+  pre.src-io:before { content: 'IO'; }
+  pre.src-J:before { content: 'J'; }
+  pre.src-makefile:before { content: 'Makefile'; }
+  pre.src-maxima:before { content: 'Maxima'; }
+  pre.src-perl:before { content: 'Perl'; }
+  pre.src-picolisp:before { content: 'Pico Lisp'; }
+  pre.src-scala:before { content: 'Scala'; }
+  pre.src-shell:before { content: 'Shell Script'; }
+  pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
+  /* additional language identifiers per "defun org-babel-execute"
+       in ob-*.el */
+  pre.src-cpp:before  { content: 'C++'; }
+  pre.src-abc:before  { content: 'ABC'; }
+  pre.src-coq:before  { content: 'Coq'; }
+  pre.src-groovy:before  { content: 'Groovy'; }
+  /* additional language identifiers from org-babel-shell-names in
+     ob-shell.el: ob-shell is the only babel language using a lambda to put
+     the execution function name together. */
+  pre.src-bash:before  { content: 'bash'; }
+  pre.src-csh:before  { content: 'csh'; }
+  pre.src-ash:before  { content: 'ash'; }
+  pre.src-dash:before  { content: 'dash'; }
+  pre.src-ksh:before  { content: 'ksh'; }
+  pre.src-mksh:before  { content: 'mksh'; }
+  pre.src-posh:before  { content: 'posh'; }
+  /* Additional Emacs modes also supported by the LaTeX listings package */
+  pre.src-ada:before { content: 'Ada'; }
+  pre.src-asm:before { content: 'Assembler'; }
+  pre.src-caml:before { content: 'Caml'; }
+  pre.src-delphi:before { content: 'Delphi'; }
+  pre.src-html:before { content: 'HTML'; }
+  pre.src-idl:before { content: 'IDL'; }
+  pre.src-mercury:before { content: 'Mercury'; }
+  pre.src-metapost:before { content: 'MetaPost'; }
+  pre.src-modula-2:before { content: 'Modula-2'; }
+  pre.src-pascal:before { content: 'Pascal'; }
+  pre.src-ps:before { content: 'PostScript'; }
+  pre.src-prolog:before { content: 'Prolog'; }
+  pre.src-simula:before { content: 'Simula'; }
+  pre.src-tcl:before { content: 'tcl'; }
+  pre.src-tex:before { content: 'TeX'; }
+  pre.src-plain-tex:before { content: 'Plain TeX'; }
+  pre.src-verilog:before { content: 'Verilog'; }
+  pre.src-vhdl:before { content: 'VHDL'; }
+  pre.src-xml:before { content: 'XML'; }
+  pre.src-nxml:before { content: 'XML'; }
+  /* add a generic configuration mode; LaTeX export needs an additional
+     (add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
+  pre.src-conf:before { content: 'Configuration File'; }
+
+  table { border-collapse:collapse; }
+  caption.t-above { caption-side: top; }
+  caption.t-bottom { caption-side: bottom; }
+  td, th { vertical-align:top;  }
+  th.org-right  { text-align: center;  }
+  th.org-left   { text-align: center;   }
+  th.org-center { text-align: center; }
+  td.org-right  { text-align: right;  }
+  td.org-left   { text-align: left;   }
+  td.org-center { text-align: center; }
+  dt { font-weight: bold; }
+  .footpara { display: inline; }
+  .footdef  { margin-bottom: 1em; }
+  .figure { padding: 1em; }
+  .figure p { text-align: center; }
+  .inlinetask {
+    padding: 10px;
+    border: 2px solid gray;
+    margin: 10px;
+    background: #ffffcc;
+  }
+  #org-div-home-and-up
+   { text-align: right; font-size: 70%; white-space: nowrap; }
+  textarea { overflow-x: auto; }
+  .linenr { font-size: smaller }
+  .code-highlighted { background-color: #ffff00; }
+  .org-info-js_info-navigation { border-style: none; }
+  #org-info-js_console-label
+    { font-size: 10px; font-weight: bold; white-space: nowrap; }
+  .org-info-js_search-highlight
+    { background-color: #ffff00; color: #000000; font-weight: bold; }
+  .org-svg { width: 90%; }
+  /*]]>*/-->
+</style>
+<script type="text/javascript">
+/*
+@licstart  The following is the entire license notice for the
+JavaScript code in this tag.
+
+Copyright (C) 2012-2018 Free Software Foundation, Inc.
+
+The JavaScript code in this tag is free software: you can
+redistribute it and/or modify it under the terms of the GNU
+General Public License (GNU GPL) as published by the Free Software
+Foundation, either version 3 of the License, or (at your option)
+any later version.  The code is distributed WITHOUT ANY WARRANTY;
+without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE.  See the GNU GPL for more details.
+
+As additional permission under GNU GPL version 3 section 7, you
+may distribute non-source (e.g., minimized or compacted) forms of
+that code without the copy of the GNU GPL normally required by
+section 4, provided you include this license notice and a URL
+through which recipients can access the Corresponding Source.
+
+
+@licend  The above is the entire license notice
+for the JavaScript code in this tag.
+*/
+<!--/*--><![CDATA[/*><!--*/
+ function CodeHighlightOn(elem, id)
+ {
+   var target = document.getElementById(id);
+   if(null != target) {
+     elem.cacheClassElem = elem.className;
+     elem.cacheClassTarget = target.className;
+     target.className = "code-highlighted";
+     elem.className   = "code-highlighted";
+   }
+ }
+ function CodeHighlightOff(elem, id)
+ {
+   var target = document.getElementById(id);
+   if(elem.cacheClassElem)
+     elem.className = elem.cacheClassElem;
+   if(elem.cacheClassTarget)
+     target.className = elem.cacheClassTarget;
+ }
+/*]]>*///-->
+</script>
+</head>
+<body>
+<div id="content">
+<div id="table-of-contents">
+<h2>Table of Contents</h2>
+<div id="text-table-of-contents">
+<ul>
+<li><a href="#org030e7a3">1. ck</a></li>
+<li><a href="#org64b2495">2. build it</a>
+<ul>
+<li><a href="#org1ba4a90">2.1. requirements</a></li>
+<li><a href="#orga58ac2a">2.2. compiler</a></li>
+<li><a href="#org85b9108">2.3. make</a></li>
+</ul>
+</li>
+<li><a href="#orgc667e72">3. for devs</a>
+<ul>
+<li><a href="#org3fafd79">3.1. make</a></li>
+<li><a href="#orge454e00">3.2. tests</a>
+<ul>
+<li><a href="#orgb5a537f">3.2.1. run tests</a></li>
+<li><a href="#orgb4ad06c">3.2.2. test suite</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<p align="center"><img src="res/logo.png" width="30%" height="30%" /></p>
+<div id="outline-container-org030e7a3" class="outline-2">
+<h2 id="org030e7a3"><span class="section-number-2">1</span> ck</h2>
+<div class="outline-text-2" id="text-1">
+<p>
+<b>The Config Keeper</b>
+</p>
+</div>
+</div>
+
+<div id="outline-container-org64b2495" class="outline-2">
+<h2 id="org64b2495"><span class="section-number-2">2</span> build it</h2>
+<div class="outline-text-2" id="text-2">
+</div>
+<div id="outline-container-org1ba4a90" class="outline-3">
+<h3 id="org1ba4a90"><span class="section-number-3">2.1</span> requirements</h3>
+<div class="outline-text-3" id="text-2-1">
+<ul class="org-ul">
+<li>clang (llvm) or gcc (gnu)</li>
+<li>cmake</li>
+<li>sqlite3-dev</li>
+</ul>
+</div>
+</div>
+
+<div id="outline-container-orga58ac2a" class="outline-3">
+<h3 id="orga58ac2a"><span class="section-number-3">2.2</span> compiler</h3>
+<div class="outline-text-3" id="text-2-2">
+<p>
+By default I use clang, if you want to use gcc just
+edit the <code>CMakeLists.txt</code> file and change <code>clang</code> to <code>gcc</code>
+</p>
+</div>
+</div>
+
+<div id="outline-container-org85b9108" class="outline-3">
+<h3 id="org85b9108"><span class="section-number-3">2.3</span> make</h3>
+<div class="outline-text-3" id="text-2-3">
+<div class="org-src-container">
+<pre class="src src-sh"><span style="color: #656565;"># </span><span style="color: #757575;">clone the repo</span>
+&gt; 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>
+&gt; mkdir ~/ck_build; <span style="color: #528fd1;">cd</span> ~/ck_build;
+<span style="color: #656565;"># </span><span style="color: #757575;">run cmake</span>
+&gt; cmake ~/code/ck
+<span style="color: #656565;"># </span><span style="color: #757575;">run make</span>
+&gt; make
+<span style="color: #656565;"># </span><span style="color: #757575;">run ck</span>
+&gt; ./ck
+</pre>
+</div>
+</div>
+</div>
+</div>
+
+<div id="outline-container-orgc667e72" class="outline-2">
+<h2 id="orgc667e72"><span class="section-number-2">3</span> for devs</h2>
+<div class="outline-text-2" id="text-3">
+</div>
+<div id="outline-container-org3fafd79" class="outline-3">
+<h3 id="org3fafd79"><span class="section-number-3">3.1</span> make</h3>
+<div class="outline-text-3" id="text-3-1">
+<p>
+Just build with address sanitizer enabled like so:
+llvm has better asan than gcc, so I use that.
+</p>
+<div class="org-src-container">
+<pre class="src src-sh"><span style="color: #656565;"># </span><span style="color: #757575;">clone the repo</span>
+&gt; 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>
+&gt; mkdir ~/ck_build; <span style="color: #528fd1;">cd</span> ~/ck_build;
+<span style="color: #656565;"># </span><span style="color: #757575;">run cmake</span>
+&gt; cmake ~/code/ck -DCK_ASAN=ON
+<span style="color: #656565;"># </span><span style="color: #757575;">run make</span>
+&gt; make
+<span style="color: #656565;"># </span><span style="color: #757575;">run ck</span>
+&gt; ./ck
+</pre>
+</div>
+</div>
+</div>
+
+<div id="outline-container-orge454e00" class="outline-3">
+<h3 id="orge454e00"><span class="section-number-3">3.2</span> tests</h3>
+<div class="outline-text-3" id="text-3-2">
+<p>
+The testing "suite" is a bash script that runs regression
+and unit tests. Regression tests are under the <code>tests/</code> directory
+and are bash scripts that test <code>ck</code> functionality. Unit tests reside
+under <code>unit/</code> directory and test the code.
+</p>
+</div>
+
+<div id="outline-container-orgb5a537f" class="outline-4">
+<h4 id="orgb5a537f"><span class="section-number-4">3.2.1</span> run tests</h4>
+<div class="outline-text-4" id="text-3-2-1">
+<p>
+Simply go to the build dir and type.
+</p>
+<div class="org-src-container">
+<pre class="src src-sh">$ ./check_ck
+</pre>
+</div>
+</div>
+</div>
+
+<div id="outline-container-orgb4ad06c" class="outline-4">
+<h4 id="orgb4ad06c"><span class="section-number-4">3.2.2</span> test suite</h4>
+<div class="outline-text-4" id="text-3-2-2">
+<div class="org-src-container">
+<pre class="src src-sh">$ ./check_ck -h
+ck test suite
+use without flags to run all tests
+
+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
+  -h, --help, *         print this
+</pre>
+</div>
+</div>
+</div>
+</div>
+</div>
+</div>
+<div id="postamble" class="status">
+<p class="date">Created: 2018-09-20 Thu 20:23</p>
+<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
+</div>
+</body>
+</html>
author	gramanas <anastasis.gramm2@gmail.com>	2018-09-20 20:22:21 +0300
committer	gramanas <anastasis.gramm2@gmail.com>	2018-09-20 20:25:14 +0300
commit	e9d38489372de572cfdb4f7f187957ecd8a0c706 (patch)
tree	248a78c7177727ea7d7908f4fb15c05405adf4d6 /README.html
parent	8693064200ad015a6b6d07f99a3170fa89012a71 (diff)
download	ck-e9d38489372de572cfdb4f7f187957ecd8a0c706.tar.gz ck-e9d38489372de572cfdb4f7f187957ecd8a0c706.tar.bz2 ck-e9d38489372de572cfdb4f7f187957ecd8a0c706.zip