Merge branch 'master' of https://github.com/dopefishh/cc1516

[cc1516.git] / README.md

diff --git a/README.md b/README.md
index 35c4616..18cae80 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,29 @@
-# cc1516
\ No newline at end of file
+#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`.
+
+## Fun
+You can verify the parser and pretty printer by running:
+```
+diff -s <(./spl examples/example.spl | ./spl) <(./spl examples/example.spl)
+```
+
+## `LICENCE`
+See `LICENCE` file.