summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefan Radomski <github@mintwerk.de>2016-05-19 21:26:48 (GMT)
committerStefan Radomski <github@mintwerk.de>2016-05-19 21:26:48 (GMT)
commit21df384751432f9717b3cd91784df1f022e7d3d3 (patch)
treed41fd8a3322b4a21ae8bde2438ecc9a18e2829bf
parent8ba26b482ba3f37ce262940af70650be399fd548 (diff)
downloaduscxml-21df384751432f9717b3cd91784df1f022e7d3d3.zip
uscxml-21df384751432f9717b3cd91784df1f022e7d3d3.tar.gz
uscxml-21df384751432f9717b3cd91784df1f022e7d3d3.tar.bz2
Github Markdown Anchors
-rw-r--r--README.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/README.md b/README.md
index ece7b75..a6f5c86 100644
--- a/README.md
+++ b/README.md
@@ -6,26 +6,26 @@
**Note**: Some of the features described below may not yet have made it into the new version, but all will eventually. If I implied functionality not yet available just call me out on it and post an issue and I will make it a priority.
-## What is it? [what]
+## What is it?
uSCXML is a platform to work with state-charts given as
[SCXML](http://www.w3.org/TR/scxml/) files. Currently, it consists of three principal components:
- 1. `libuscxml`: [C++ library](#library) containing an interpreter and accompanying functionality.
+ 1. `libuscxml`: [C++ library](#embedded-as-a-library) containing an interpreter and accompanying functionality.
- 2. `uscxml-browser`: A standards compliant [command-line interpreter](#cli) of SCXML documents.
+ 2. `uscxml-browser`: A standards compliant [command-line interpreter](#on-the-command-line) of SCXML documents.
- 3. `uscxml-transform`: A collection of [transformation](#transform) implementations to transpile SCXML, e.g. onto ANSI-C and VHDL.
+ 3. `uscxml-transform`: A collection of [transformation](#for-transformations) implementations to transpile SCXML, e.g. onto ANSI-C and VHDL.
-## Installation [install]
+## Installation
There are no installers yet and we do not feature any releases. Just check for [open issues](https://github.com/tklab-tud/uscxml/issues) and [build from source](http://tklab-tud.github.io/uscxml/building.html). If you did download and build locally, you can create installers via `make packages` though.
-## Documentation [doc]
+## Documentation
Documentation is available at our [github pages](http://tklab-tud.github.io/uscxml/). It is created from inline comments in the source along with some dedicated markdown pages via `doxygen`. We try to keep it current and will update it ever again. For the most current documentation, you can run `make docs` in your build directory.
-## Licensing [license]
+## Licensing
uSCXML itself is distributed under the [Simplified BSD license](http://www.opensource.org/licenses/bsd-license) as in, do not sue
us and do not misrepresent authorship. There are currently four additional libraries that are required to compile uSCXML.
@@ -39,20 +39,20 @@ us and do not misrepresent authorship. There are currently four additional libra
At configure time, the uSCXML build-process will attempt to find and link several other libraries (e.g. Lua, v8) and additional licensing terms may apply.
-## Getting Started [started]
+## Getting Started
For more detailled information, refer to the [documentation](http://tklab-tud.github.io/uscxml).
-### Embedded as a Library [library]
+### Embedded as a Library
uscxml::Interpreter scxml = uscxml::Interpreter::fromURL("...");
while(scxml.step() != uscxml::USCXML_FINISHED) {
...
}
-### On the Command-line [cli]
+### On the Command-line
# interpret state-chart from url
$ uscxml-browser https://raw.githubusercontent.com/tklab-tud/uscxml/master/test/w3c/null/test436.scxml
-### For Transformations [transform]
+### For Transformations
# transform given SCXML document into ANSI-C fragment
$ uscxml-transform -tc -i https://raw.githubusercontent.com/tklab-tud/uscxml/master/test/w3c/null/test436.scxml