added LDoc documentation

* gives a useful overview of everything supported right now
* especially the type documentation is useful, as these things are not self-evident in Lua (because of dynamic typing).
* The LDoc page can later be published as the Github pages of the project.
  This can even be done automatically by a Github action.
  However, we should first make sure that it's okay to publish the project before defending the thesis since
  Github pages will always be public even for private repositories.
* Documentation of command-line parameters is lacking (TODO).
* It may be possible to use types like "Stream(number)" to describe streams of numbers.
  The LDoc documentation mentions boxed types.
  Perhaps there can even be Streamable(number)?
* We are also lacking good example programs and/or introductory material.

1 files changed, 11 insertions, 0 deletions

diff --git a/README.md b/README.md
index bd81e57..685efd3 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,17 @@ Furthermore, install the following dependencies:
     sudo apt-get install build-essential libreadline-dev libjack-jackd2-dev \
                          libsndfile1 libasound2 feedgnuplot
 
+To compile the project, type:
+
+    make
+
+Up-to-date documentation is available at the [website](http://rhaberkorn.github.io/applause2).
+In case you want to build it manually, install the `lua-ldoc` and `lua-discount` packages and type:
+
+    make doc
+
+The generated documentation will be generated in the `doc/` subdirectory.
+
 ## Usage
 
 Start qjackctl.