about summary refs log tree commit diff
path: root/src/index.mld
diff options
context:
space:
mode:
Diffstat (limited to 'src/index.mld')
-rw-r--r--src/index.mld17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/index.mld b/src/index.mld
new file mode 100644
index 0000000..d69efff
--- /dev/null
+++ b/src/index.mld
@@ -0,0 +1,17 @@
+{0 logbook}
+
+The [logbook] package includes a command line utility and a OCaml library for dealing with [log] files.
+
+{1 log files}
+
+[log] is a file format for personal diary or log keeping. For detailed information on the
+[log] file format see [man 7 logbook-log] or the [README.md] distributed with this package.
+
+{1 Log}
+
+The {!module-Log} module allows for parsing and manipulation of an OCaml representation of [log] files.
+
+{1 logbook}
+
+For usage information for the [logbook] utility that can generate HTML from [log] files see [man logbook]
+or the [README.md] distributed with this package.