mclemens
/
esm2markdown
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated README

This commit is contained in:
Michael Clemens 2018-03-22 20:11:43 +01:00
parent 8ad9f980b3
commit ba705f8a65
1 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -6,25 +6,37 @@ This python script is intended to be used to automatically generate use case / c
This tool requires the following: This tool requires the following:
* Python 3 * Python 3
* lxml * lxml (XML parser that understands CDATA)
* networkx * networkx (needed for creating graphs)
* pydot * pydot (needed for creating graphs)
* pandoc (for converting to other formats than Markdown)
On Debian you can install the dependencies with "sudo apt-get install python3-lxml python3-networkxi python3-pydot" On Debian you can install the dependencies with "sudo apt-get install python3-lxml python3-networkxi python3-pydot"
## Usage ## Usage
Please configure esm2markdown.ini to your liking and execute esm2markdown.py like this:
``` ```
python esm2markdown <rule xml file> <markdown output file> # python esm2markdown.py <rule xml file> <markdown output file>
``` ```
## Example ## Example
### Convert xml to Markdown
``` ```
python esm2markdown demo.xml demo.mk # python esm2markdown demo.xml demo.mk
``` ```
After a conversion with pandoc, the following documentation will be the result: ### Convert to Markdown to DOCX
```
# pandoc -s demo.mk -o demo.docx
```
In the end, the result should look like this shortened output:
![screenshot](demo/demo.png "") ![screenshot](demo/demo.png "")