lmu/uni2work.workflows.visualiser
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
David Mosbach 2023-05-30 16:32:08 +02:00
parent 033f5e1b8d
commit cd2c624300
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -2,12 +2,15 @@
## Usage ## Usage
You need to host a local http server for providing the definition files. Please create a dedicated directory @ `localhost` for that purpose.
### Prerequisites
First, you need to generate the visualisation data: First, you need to generate the visualisation data:
``` ```
cabal run workflow-visualiser -- <source.yaml> <target.json> cabal run workflow-visualiser -- --all <path-to-source-yaml-directory> <directory-of-http-server>
``` ```
Copy the contents of `target.json` and paste them as the value of the variable `workflow` into the first line of [`editor.js`](./editor.js#L1). Afterwards you can run your server and listen on port `8080`.
### Open Editor
Open `editor.html` in order to display the graph. Open `editor.html` in your browser and select the desired workflow via the file menu.