summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorStefan Radomski <radomski@tk.informatik.tu-darmstadt.de>2014-08-21 11:19:08 (GMT)
committerStefan Radomski <radomski@tk.informatik.tu-darmstadt.de>2014-08-21 11:19:08 (GMT)
commita3fb1daf5b4e58471cc714853636025b6cac9aed (patch)
tree03f60a2f396f7d339a0733099da0f56f64c8d822 /README.md
parent7454d99f1d02c68706da1ed6237a5f391291942d (diff)
downloaduscxml-a3fb1daf5b4e58471cc714853636025b6cac9aed.zip
uscxml-a3fb1daf5b4e58471cc714853636025b6cac9aed.tar.gz
uscxml-a3fb1daf5b4e58471cc714853636025b6cac9aed.tar.bz2
Reactiveted new CMake policies and some more documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/README.md b/README.md
index a5920f7..207b3b7 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@
- [Test Reports](#test-reports)
- [License](#license)
- [Download](#download)
-- [Usage](#usage)
+- [Getting Started](#getting-started)
- [Advanced Topics](#advanced-topics)
- [Embedding uSCXML](#embedding-uscxml)
- [Extending uSCXML](#extending-uscxml)
@@ -19,6 +19,11 @@
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+#### Related Documents
+
+- [Building form Source](docs/BUILDING.md)
+- [Developer Overview](docs/OVERVIEW.md)
+
## General
uSCXML is a SCXML interpreter written in C/C++. It is [standards compliant](#test-reports) and [easily extended](#extending-uscxml)
@@ -94,7 +99,7 @@ upon](https://github.com/tklab-tud/uscxml/blob/master/docs/BUILDING.md#build-dep
We do not yet feature installers. Please download the source and have a look at the [build
instructions](https://github.com/tklab-tud/uscxml/blob/master/docs/BUILDING.md).
-## Usage
+## Getting Started
In order to use the interpreter, you need to <tt>#include "uscxml/Interpreter.h"</tt> and instantiate
objects of <tt>uscxml::Interpreter</tt>.