README.md

   1 #spl
   2 `<spl> ::= <spl> <parsing> <lexing>`
   3
   4 ## Build instructions
   5 To build you need to have a [clean](http://clean.cs.ru.nl) system on
   6 your machine. More specifically the development version since we use the
   7 `clean-platform` library.
   8
   9 ### Linux
  10 Append `envs/envs.linux64` to your `IDEEnvs` and run `make`.
  11
  12 ### Mac
  13 Append `envs/envs.mac` to your `IDEEnvs` and run `make`.
  14
  15 ### Windows
  16 Install a real operating system and try again.
  17
  18 ## Usage
  19 If `help2man` is installed you can generate a manpage by running `make man`.
  20 For full instruction see `man ./spl.1` or run `./spl --help`.
  21
  22 ## Fun
  23 You can verify the parser and pretty printer by running:
  24 ```
  25 diff -s <(./spl examples/example.spl | ./spl) <(./spl examples/example.spl)
  26 ```
  27
  28 ## `LICENCE`
  29 See `LICENCE` file.