updated directory structure

[cc1516.git] / README.md

diff --git a/README.md b/README.md
index 167a116..dc15e87 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
-# 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
+For full instruction see `man ./spl.1` or run `./spl --help`.
+
+## `LICENCE`
+See `LICENCE` file.