README.md in trollolo-0.1.1 vs README.md in trollolo-0.2.0
- old
+ new
@@ -19,10 +19,12 @@
[example Trello board](https://trello.com/b/CRdddpdy/trollolo-testing-board)
which demonstrates the expected structure.
## Installation
+You need to have Ruby install. Trollolo works with Ruby 2.2-2.4.1, but currently it doesn't work with 2.4.2. See [#139](https://github.com/openSUSE/trollolo/issues/139) for more information.
+
You can install Trollolo as gem with `gem install trollolo`.
For the chart generation you will need a working matplotlib installation and
the python module to read YAML. On openSUSE you can get that with
@@ -89,10 +91,17 @@
reads the data. In the future it would be great, if it could also write back
the generated data and results to make it even more automatic.
The work flow goes as follows:
-Create an initial working directory for the burndown chart generation:
+Start the workflow by using the current directory as working directory and
+initialize it for the burndown chart generation:
+
+ trollolo burndown-init --board-id=MYBOARDID
+
+By default, trollolo uses the current directory as working directory, if you
+want to specify another directory as working directory, use the `--output`
+option as follows:
trollolo burndown-init --board-id=MYBOARDID --output=WORKING_DIR
This will create a directory WORKING_DIR and put an initial data file there,
which contains the meta data. The file is called `burndown-data-1.yaml`. You