Skip to content

Commit

Permalink
Link to metafacture-tutorial
Browse files Browse the repository at this point in the history
See metafacture-tutorial#1.
  • Loading branch information
dr0i committed Mar 25, 2024
1 parent 5039584 commit 0c30e08
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
1 change: 1 addition & 0 deletions getting-started.html
Expand Up @@ -109,6 +109,7 @@ <h2 id="playground">Playground</h2>
<p>The easiest way to get started with Metafacture is the Playground. Take a look at an <a href="https://metafacture.org/playground/?example=encode-xml">example</a> and run it by pressing the <img src="img/process.png" alt="“Process”" /> button. Check out the other examples (first button, <img src="img/load-exmples.png" alt="“Load Examples”" />) for different input sources, transformations, and output formats.</p>
<p>For commands available in the Flux, see <a href="https://github.com/metafacture/metafacture-documentation/blob/master/flux-commands.md">the Flux commands documentation</a>.</p>
<p>For functions and usage of the Fix, see <a href="https://github.com/metafacture/metafacture-documentation/blob/master/Fix-function-and-Cookbook.md">the Fix functions and cookbook</a>.</p>
<p>For a tutorial, see <a href="https://metafacture.github.io/metafacture-tutorial/">metafacture-tutorial</a>.</p>
<h2 id="command-line">Command line</h2>
<p>To use Metafacture as a command-line tool, download the latest metafix-runner from our <a href="https://github.com/metafacture/metafacture-fix/releases">releases page</a>. Extract the downloaded archive and change into the newly created directory (e.g. <code>cd metafacture-runner-0.4.0</code>). Run a Flux workflow with:</p>
<p><code>$ ./bin/metafix-runner /path/to/your.flux</code> on Unix/Linux/Mac or <code>$ ./bin/metafix-runner.bat /path/to/your.flux</code> on Windows.</p>
Expand Down
2 changes: 2 additions & 0 deletions getting-started.md
Expand Up @@ -12,6 +12,8 @@ For commands available in the Flux, see [the Flux commands documentation](https:

For functions and usage of the Fix, see [the Fix functions and cookbook](https://github.com/metafacture/metafacture-documentation/blob/master/Fix-function-and-Cookbook.md).

For a tutorial, see [metafacture-tutorial](https://metafacture.github.io/metafacture-tutorial/).

## Command line

To use Metafacture as a command-line tool, download the latest metafix-runner from our [releases page](https://github.com/metafacture/metafacture-fix/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:
Expand Down

0 comments on commit 0c30e08

Please sign in to comment.