Browse Source

Added README to the project

Yentl Van Tendeloo 9 years ago
parent
commit
d51abba183
1 changed files with 14 additions and 0 deletions
  1. 14 0
      README.md

+ 14 - 0
README.md

@@ -0,0 +1,14 @@
+Execution
+=========
+
+Execute the file *examples/client.py* to start up the debugging interface for a model.
+The model is, however, hardcoded to the *model.py* file, with the *Root* coupled model.
+The *examples/client.py* file is only an example, and can be easily modified, as the actual debugging logic is stored in the *src* folder, specifically in the Statechart stored in *src/sccd.xml*.
+
+Benchmarks
+==========
+
+To execute the benchmarks, and automatically generate their plots, run the command
+```sh
+./run_benchmarks.sh
+```