Skip to content

Commit 1adaf91

Browse files
authored
Revise command line usage instructions for Metafacture (#60)
1 parent 2a9db12 commit 1adaf91

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

docs/Getting-Started.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,18 @@ For next steps get familar with [FLUX](flux/Flux-User-Guide.html) and [FIX](fix/
1818

1919
## Command line
2020

21-
To use Metafacture as a command-line tool, download the latest Metafacture release from our [releases page](https://github.com/metafacture/metafacture-core/releases). Extract the downloaded archive and change into the newly created directory (e.g. `cd metafacture-runner-0.6.1`). Run a Flux workflow with:
21+
Check if Java 11 or higher is installed with `java -version` in your terminal. If not, install Java 11 or higher.
2222

23-
`$ ./bin/metafix-runner /path/to/your.flux` on Unix/Linux/Mac or
24-
`$ ./bin/metafix-runner.bat /path/to/your.flux` on Windows.
23+
To use Metafacture as a command-line tool, download the latest Metafacture release from our [releases page](https://github.com/metafacture/metafacture-core/releases).
24+
25+
Download metafacture-core-$VERSION-dist.tar.gz or the zip version and extract the archive to your choosen folder. In the folder you find the flux.bat and flux.sh
26+
27+
The code below assumes you moved the resulting folder to your home directory and renamed it to "metafacture".
28+
29+
Run a Flux workflow with:
30+
31+
`$ ./metafacture/flux.sh /path/to/your.flux` on Unix/Linux/Mac or
32+
`$ ./metafacture/flux.bat /path/to/your.flux` on Windows.
2533

2634
To get started, you can export a workflow from the Playground (last button, !["Export Workflow"](https://metafacture.org/img/export.png)).
2735

0 commit comments

Comments
 (0)