initHEADmain

1 files changed, 26 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6a5f63e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# melisma-modules
+
+A collection of modules for [melisma](/melisma).
+Documentation is located [here](/melisma-modules/doc).
+
+## Building and installing
+
+Make sure melisma is installed and that melisma.h.pc is in PKG_CONFIG_PATH.
+Copy config/config.mk to the root directory.
+Edit config.mk to customize which modules will be
+built/installed. Then build and install with:
+
+```bash
+$ make install CMODULE_PREFIX=... LUAMODULE_PREFIX=...
+```
+
+Some modules may require additional system libraries.
+Which modules need which libraries should be evident from the Makefile.
+
+To make modules available for import, make sure the installation
+prefixes are in LUA_PATH and LUA_CPATH.
+
+## Licensing
+
+melisma is licensed under GPL v3 or later (see COPYING).
+ladspa.h is licensed under LGPL 2.1 or later (see COPYING.LGPL).