Commit 9485cd4e authored by Adrian Wuillemet's avatar Adrian Wuillemet
Browse files

#65 Correct README.md

parent 1ff7bf54
......@@ -69,7 +69,7 @@ that do not care about the GUI.<br>
<br>
Chrome or Chromium is only a soft dependency, with which **Beads<sup>©</sup>** - GUI
works best. Alternatively any other modern web browser will suffice and the system standard
browser will be used, if no chrome is detected.
browser will be used, if no Chrome is detected.
<br>
<br>
......@@ -81,7 +81,7 @@ We deploy the tool and all updates via the [Python Package Index](https://pypi.o
hands on the tool simply install it with _pip_ and you are good to go.
```shell
$ pip install beads
$ pip install Beads
```
Any internal dependencies will be handled by pip!<br>
......@@ -253,9 +253,10 @@ State machines can be provided in textual representations. Currently there are t
To provide a state machine as a JSON file follow the schema below:
Three attributes are required:
+ A **name** for the machine
+ A list of **nodes** with an "ID" representing the states
+ A list of **transitions** with "from" and "to" referencing nodes, and a "label"
+ A **name** for the machine
+ A list of **nodes** with an "ID" representing the states
+ A list of **transitions** with "from" and "to" referencing nodes, and a "label"
To declare a state as the initial starting state append '"start":true' to the node.
......@@ -276,20 +277,20 @@ To declare a state as the initial starting state append '"start":true' to the no
**Bead format**
As an easy-to-write alternativ to json files we accept **.bead** files that adhere to the following format:
As an easy-to-write alternative to json files the tool accepts **.bead** files that adhere to the following format:
```
#! name:NAME start:ID1
#! name:NAME start:ID1
ID1:TRANS1:ID2
ID2:TRANS2:ID1
ID1:TRANS1:ID2
ID2:TRANS2:ID1
```
The **.bead** format is transition based. All transitions follow the schema:<br>
FROM_STATE : TRNASITION_NAME : TO_STATE<br>
FROM_STATE : TRANSITION_NAME : TO_STATE<br>
The name and the starting point are optional and can be declared as key:value pairs in a config comment on the top of the file.
The comment has to start with '#!' and is followed by a whitespace.
The comment has to start with '#!' which is followed by a whitespace.
Parsing of **.bead** files will extract all referenced states so they do not have to be declared separately.
......
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