refactoors

[mTask.git] / README.md

diff --git a/README.md b/README.md
index ff2a986..0c4f2a8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,51 +7,35 @@ bytecode which is interpreted by the engine that has to be programmed on the
 device.
 
 The devices suitable for *mTasks* are not limited to embedded devices. In the
-`int` folder is a `C` reference implementation available for intel machines.
+`client` folder is a `C` reference implementation available for intel machines.
 
-*mTasks* are written in [clean][clean] and specifically using the
-[iTasks][itasks] library.
+*mTasks* are written in [clean][clean] and specifically using the TOP
+implementation DSL [iTasks][itasks].
 
-### Workings of an *mTask* system
-*mTasks* are routines that are executed in a round robin fashion
+### How to setup the server
+Install clean by running:
+```
+./install_clean.sh
+```
 
-### Communication back to the server via shared data sources
-When a shared data source is updated the *mTask* can publish this data back to
-the server. This is usefull when for example a temperature reaches a certain
-threshhold. How this communication will be done is yet to be researched.
-**TODO**
+Build the tools by running `make`
 
-### Usage
-All programs can be built by running `make`. Note that you need the latest
-`clm` version if you want to use the `Makefile` since hierarchical modules are
-used. This version can be found [here][clm].
+### How to setup the interpreters
+For the linux version install `gcc` and run `make -C client -f Makefile.linux`.
 
-The following programs are available as of now:
-- `mTaskExamples`
+For the STM version install `gcc-arm-none-eabi` and run `make -C client`. 
+To flash the binary to the device install (a recent version of)
+`openocd` and run `make -C client flash`.
 
-       This compiles a list of mTask examples to `C` code.
-
-- `mTaskMakeSymbols`
-
-       This creates the `mTaskSymbols.h` header file
-
-- `mTaskInterpret`
-
-       This compiles a subset of *mTasks* to bytecode.
-
-### Protocol
-The engine starts with no tasks. To send a new task the following protocol must
-be adhered.
-**TODO**
-
-### Bytecode operations
-The header file for the interpreter with the corresponding bytevalues can be
-generated by running `mTaskMakeSymbols`.
+### Thesis
+The thesis accompanying this material can be found [here][thesis] and the
+sources [here][sources]
 
 ### Author(s)
-Initial work has been done by Pieter Koopman. Extensions have been made by Mart
-Lubbers.
+Initial work on the DSL have been done by Pieter Koopman. Further extensions
+have been made by Mart Lubbers.
 
-[clm]: https://svn.cs.ru.nl/repos/clean-tools/trunk/clm
+[sources]: https://files.martlubbers.net/msc-thesis1617://git.martlubbers.net/?p=msc-thesis1617.git;a=summary 
+[thesis]: https://files.martlubbers.net/msc-thesis1617/
 [clean]: clean.cs.ru.nl
 [itasks]: clean.cs.ru.nl/ITasks