X-Git-Url: https://git.martlubbers.net/?a=blobdiff_plain;f=src%2FREADME.md;h=fded7762fde38eebc85f2bbc694c4cdd2d1684df;hb=fa2b27e75142781978149dc3e906e8b5aae8e603;hp=96324be27c26459f77ffcffb32c1284f0cb0ff64;hpb=17935415709334265fc11a9f1d12022b342094d1;p=cc1516.git diff --git a/src/README.md b/src/README.md index 96324be..fded776 100644 --- a/src/README.md +++ b/src/README.md @@ -1,7 +1,11 @@ #spl ` ::= ` -## Instructions +## 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`. @@ -9,27 +13,10 @@ Append `envs/envs.linux64` to your `IDEEnvs` and run `make`. Append `envs/envs.mac` to your `IDEEnvs` and run `make`. ### Windows -Install a real operating system. And try again.o - -## `LICENCE` -The MIT License (MIT) +Install a real operating system. And try again. -Copyright (c) 2016 Pim Jager & Mart Lubbers +## Usage +For full instruction see `man ./spl.1` or run `./spl --help`. -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies -of the Software, and to permit persons to whom the Software is furnished to do -so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +## `LICENCE` +See `LICENCE` file.