X-Git-Url: https://git.martlubbers.net/?a=blobdiff_plain;f=README.md;h=2747d59301898d14598e1474b48bc9dbc5a169de;hb=6703509b4b132cee0f4c91dc23795d3d4ab131e8;hp=167a116aa7d4a6e11ab9882bac1b5c2fbd06979b;hpb=19c5f39c61f1692641570dc3cf13360e7dff5cdf;p=cc1516.git

diff --git a/README.md b/README.md
index 167a116..2747d59 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,23 @@
-# cc1516
+#spl
+`<spl> ::= <spl> <parsing> <lexing>`
+
+## Build instructions
+To build you need to have a [clean](http://clean.cs.ru.nl) system on
+your machine. More specifically the development version since we use the
+`clean-platform` library.
+
+### Linux
+Append `envs/envs.linux64` to your `IDEEnvs` and run `make`.
+
+### Mac
+Append `envs/envs.mac` to your `IDEEnvs` and run `make`.
+
+### Windows
+Install a real operating system and try again.
+
+## Usage
+If `help2man` is installed you can generate a manpage by running `make man`.
+For full instruction see `man ./spl.1` or run `./spl --help`.
+
+## `LICENCE`
+See `LICENCE` file.