summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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.
+