Skip to content

Commit 82087a1

Browse files
authored
Update command line usage and Java installation check
Added instructions for checking Java installation and updated command usage for running Flux workflows.
1 parent 69cc4a1 commit 82087a1

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

getting-started.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,18 @@ For a tutorial, see [metafacture-tutorial](https://metafacture.github.io/metafac
1616

1717
## Command line
1818

19-
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.4.0`). Run a Flux workflow with:
19+
Check if Java 11 or higher is installed with java -version in your terminal. If not, install Java 11 or higher.
2020

21-
`$ ./bin/metafix-runner /path/to/your.flux` on Unix/Linux/Mac or
22-
`$ ./bin/metafix-runner.bat /path/to/your.flux` on Windows.
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).
22+
23+
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
24+
25+
The code below assumes you moved the resulting folder to your home directory and renamed it to "metafacture".
26+
27+
Run a Flux workflow with:
28+
29+
`$ ./metafacture/flux.sh /path/to/your.flux` on Unix/Linux/Mac or
30+
`$ ./metafacture/flux.bat /path/to/your.flux` on Windows.
2331

2432
To get started, you can export a workflow from the Playground (last button, !["Export Workflow"](img/export.png)).
2533

0 commit comments

Comments
 (0)