From e42aa4cc763e8da686e785139291b26ff5eecd3e Mon Sep 17 00:00:00 2001 From: David Mosbach Date: Sat, 26 Aug 2023 05:23:35 +0200 Subject: [PATCH] updated readme --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4e98207..7ac961b 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,23 @@ # Workflow Visualiser ## Usage - -You need to host a local http server for providing the definition files. Please create a dedicated directory @ `localhost` for that purpose. ### Prerequisites +#### Data First, you need to generate the visualisation data: -``` -cabal run workflow-visualiser -- --all +```sh +$ cabal run workflow-visualiser -- --all ``` -Afterwards you can run your server and listen on port `8080`. -### Open Editor -Open `editor.html` in your browser and select the desired workflow via the file menu. \ No newline at end of file +#### Frontend +You need to install some libraries: +```sh +$ npm install +``` + +### Run +Run the following command. This will generate a Webpack bundle from the Typescript source, launch a local http server and open the application in your browser: +```sh +$ npm start +``` \ No newline at end of file