diff options
| author | sternenseemann <git@lukasepple.de> | 2017-02-14 00:24:09 +0100 |
|---|---|---|
| committer | sternenseemann <git@lukasepple.de> | 2017-02-14 00:24:15 +0100 |
| commit | ad61e882b0c45537754f0de6c2a8698b0e020028 (patch) | |
| tree | b08993447b9d858eb4df1ec9a2a1218a04373ee3 | |
| parent | e69173be484ce3f42b42c28891ef7f5e909a3f1c (diff) | |
Adjust README
| -rw-r--r-- | README.md | 34 |
1 files changed, 2 insertions, 32 deletions
diff --git a/README.md b/README.md index 75645d7..54346f7 100644 --- a/README.md +++ b/README.md @@ -2,36 +2,6 @@ logbook — tool for personal log files ------------------------------------------------------------------------------- %%VERSION%% -logbook is TODO +logbook is a small tool for dealing with log files, which were first [specified by Profpatsch](https://gist.github.com/Profpatsch/092ff68fa267b9fa0ccbe13e98149b21) (sadly only in german, I will add a translation as soon as possible). -logbook is distributed under the ISC license. - -Homepage: https://sternen.space/ocaml/logbook - -## Installation - -logbook can be installed with `opam`: - - opam install logbook - -If you don't use `opam` consult the [`opam`](opam) file for build -instructions. - -## Documentation - -The documentation and API reference is generated from the source -interfaces. It can be consulted [online][doc] or via `odig doc -logbook`. - -[doc]: https://sternen.space/logbook/doc - -## Sample programs - -If you installed logbook with `opam` sample programs are located in -the directory `opam var logbook:doc`. - -In the distribution sample programs and tests are located in the -[`test`](test) directory of the distribution. They can be built and run -with: - - topkg build --tests true && topkg test +Parsing and Representation of log files works at the moment, more to come! |