summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilipp Gesang <phg@phi-gamma.net>2018-09-09 00:46:10 +0200
committerPhilipp Gesang <phg@phi-gamma.net>2018-09-09 00:46:10 +0200
commit56a5e0c36633cdcd40352c4a9ba44f378daf7e5d (patch)
treeb1e8e59730c1ca5a974a739075a22eda4d960575
parentfe2fbd04eca6779dddfce6dbbc565e050a05ff1f (diff)
downloadcaldr-56a5e0c36633cdcd40352c4a9ba44f378daf7e5d.tar.gz
add readme
-rw-r--r--README.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..3ed8530
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,18 @@
+description
+-------------------------------------------------------------------------------
+
+*Caldr*: read / write icalendar (RFC 2445) files.
+
+Converts between ics and the remind(1) format.
+
+dependencies
+-------------------------------------------------------------------------------
+
+- A Lua interpreter; tested on 5.3;
+- *lpeg*;
+- *cjson*;
+- *luaposix* (optional).
+
+See ``misc/nix-lua-shell.nix`` for nix script that builds a working
+environment.
+