add README

1 files changed, 12 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6be2e5e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# melisma-examples
+
+A collection of example scripts for [melisma](/melisma).
+
+## Running
+
+Make sure melisma is installed and that [my melisma modules](/melisma-modules) are in `LUA_CPATH` and `LUA_PATH`.
+Then run an example with
+
+```bash
+$ melisma -C <subdirectory> main.lua
+```