Commit 48fb7dd3 authored by Christian Müller's avatar Christian Müller

readme

parent 7df8f65a
......@@ -17,12 +17,6 @@ There is a working parser that can read the ``*.spec`` files in ``/examples``.
Workflows can also be specified directly in Scala by instantiating case classes.
You can find implicits helping with that in ``de.tum.workflows.Implicits``.
## Building
To get sbt to build the project properly, you have to add the Supersafe Compiler plugin by adding
``resolvers += "Artima Maven Repository" at "http://repo.artima.com/releases"`` to ``~/.sbt/0.13/global.sbt``
(You can generate an eclipse project file for use with Scala IDE by running ``sbt eclipse`` after installing the sbt eclipse plugin)
## Example File Format
A readable example can be found at ``/examples/conference.spec``.
......@@ -54,8 +48,9 @@ Causality
# Gives a list of typed causal agents that will be instantiated and added to the universe.
```
## Testing
## Building & Testing
The project is built with ``sbt``. To run one of the executable main classes, use ``sbt run``.
To run the unit tests, you can run ``sbt test``. You can find all the unit tests in ``src/test/scala``.
To test your own examples, run ``de.tum.workflows.Main`` by using ``sbt run``. This will parse all ``.spec`` files in ``/examples/`` and will log the resulting LTL formulas to ``results/``.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment