Skip to content

Commit 5d273fe

Browse files
committed
Update the getting started page
1 parent fc512c5 commit 5d273fe

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

getting-started.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The easiest way to get started with Metafacture is the Playground. Take a look a
1010

1111
For commands available in the Flux, see [the Flux commands documentation](https://github.com/metafacture/metafacture-documentation/blob/master/flux-commands.md).
1212

13-
For functions and usage of the Fix, see [the Fix functions and cookbook](https://github.com/metafacture/metafacture-fix#functions-and-cookbook).
13+
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).
1414

1515
## Command line
1616

@@ -23,6 +23,39 @@ To get started, you can export a workflow from the Playground (last button, !["E
2323

2424
To set up IDE support for editing your Flux and Fix files, see [the IDE extensions page](/ide-extensions/index.html).
2525

26+
## Using Metafacture as a Java library
27+
28+
If you want to use Metafacture in your own Java projects all you need is to add some dependencies to your project. As of Metafacture 5, the single metafacture-core package has been replaced with a number of domain-specific packages. You can find the list of packages on [Maven Central](https://search.maven.org/search?q=g:org.metafacture).
29+
30+
Alternatively, you can simply guess the package names from the top-level folders in the source code repository -- they are the same.
31+
32+
For instance, if you want to use the `metafacture-io` library in your project, simply add the following dependency to your `pom.xml`:
33+
34+
```xml
35+
<dependency>
36+
<groupId>org.metafacture</groupId>
37+
<artifactId>metafacture-io</artifactId>
38+
<version>$VERSION</version>
39+
</dependency>
40+
```
41+
42+
or if Gradle is your build tool of choice use:
43+
44+
```groovy
45+
dependencies {
46+
implementation 'org.metafacture:metafacture-io:$VERSION'
47+
}
48+
```
49+
50+
To use Fix you would declare `metafix` instead of `metafacture-io` as in the example above. Note that `metafix` is not published to maven central but only to [github releases](https://github.com/metafacture/metafacture-fix/releases).
51+
52+
Occasionally, we publish snapshot builds on [Sonatype OSS Repository](https://oss.sonatype.org/index.html#nexus-search;gav~org.metafacture~~~~~kw,versionexpand). The version number is derived from the branch name. Snapshot builds from the master branch always have the version `master-SNAPSHOT`. We also provide sometimes pre releases as github packages.
53+
2654
## Next steps
2755

28-
For a complete introduction to Metafacture in German, check out the latest iteration of [our Metafacture Workshop](https://slides.lobid.org/2022-12-metafacture-workshop/#/). For different use cases, e.g. using Metafacture as a library, using the Morph language, and more, see [our documentation collection](https://github.com/metafacture/metafacture-documentation).
56+
Get familar with [FLUX](https://github.com/metafacture/metafacture-documentation/blob/master/Flux-User-Guide.md) and [FIX](https://github.com/metafacture/metafacture-documentation/blob/master/Fix-User-Guide.md). And try out some Metafacture workflows.
57+
58+
If you plan to use Metafacture as a Java library or if you wish to add commands to Flux you should get familar with the [Framework](https://github.com/metafacture/metafacture-documentation/blob/master/Framework-User-Guide.md).
59+
60+
For a complete introduction to Metafacture in German, check out the latest iteration of [our Metafacture Workshop](https://slides.lobid.org/2022-12-metafacture-workshop/#/).
61+
For different use cases, e.g. using Metafacture as a library, using the Morph language, and more, see [our documentation collection](https://github.com/metafacture/metafacture-documentation).

0 commit comments

Comments
 (0)