updated gitignore, licence added, project updated

diff --git a/src/.gitignore b/src/.gitignore
index aa2c2db..696ea94 100644 (file)
--- a/src/.gitignore
+++ b/src/.gitignore
@@ -1,4 +1,4 @@
 Clean System Files
 Clean System Files

-main

 sapl
 sapl

-main.1
+spl
+spl.1

diff --git a/src/LICENCE b/src/LICENCE
new file mode 100644 (file)
index 0000000..014a9d9
--- /dev/null
+++ b/src/LICENCE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Pim Jager & Mart Lubbers
+
+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.

diff --git a/src/Makefile b/src/Makefile
index 0ec7588..6b53e08 100644 (file)
--- a/src/Makefile
+++ b/src/Makefile
@@ -1,15 +1,14 @@
 CPM:=cpm
 CPM:=cpm

-BIN:=spl

 
 .PHONY: man
 
 
 .PHONY: man
 

-all: $(BIN) $(BIN).1
+all: spl spl.1

 
 

-spl:
+spl: spl.icl lex.icl lex.dcl parse.icl parse.dcl spl.prj

        $(CPM) make
 
 %.1: %
        $(CPM) make
 
 %.1: %

-       help2man ./$< > $@
+       help2man -s 1 -N -o $@ ./$<

 
 clean:
 
 clean:

-       $(RM) -rv Clean\ System\ Files $(BIN) $(BIN).1
+       $(RM) -rv Clean\ System\ Files spl spl.1

diff --git a/src/README.md b/src/README.md
index 96324be..c50d085 100644 (file)
--- a/src/README.md
+++ b/src/README.md
@@ -1,7 +1,11 @@
 #spl
 `<spl> ::= <spl> <parsing> <lexing>`
 
 #spl
 `<spl> ::= <spl> <parsing> <lexing>`
 

-## 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`.
 
 ### Linux
 Append `envs/envs.linux64` to your `IDEEnvs` and run `make`.
 


@@ -9,27 +13,11 @@ Append `envs/envs.linux64` to your `IDEEnvs` and run `make`.
 Append `envs/envs.mac` to your `IDEEnvs` and run `make`.
 
 ### Windows
 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
+When you have built the project an executable name `spl` appears. 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.

diff --git a/src/spl.prj b/src/spl.prj
index 3b57647..4c8d4bd 100644 (file)
--- a/src/spl.prj
+++ b/src/spl.prj
@@ -24,7 +24,7 @@ Global
                        Time:   False
                        Stack:  False
                Output
                        Time:   False
                        Stack:  False
                Output

-                       Output: ShowConstructors
+                       Output: NoConsole

                        Font:   Monaco
                        FontSize:       9
                        WriteStdErr:    False
                        Font:   Monaco
                        FontSize:       9
                        WriteStdErr:    False