You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-17Lines changed: 28 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -17,19 +17,28 @@ You can either use Metafacture as a stand-alone application or include it as a J
17
17
## Metafacture as a stand-alone application
18
18
19
19
If you are only interested in running Flux scripts without doing any Java programming this is the way to go. The instructions assume that you are using a \*nix-like shell. [See more information in the wiki page about Flux](https://github.com/metafacture/metafacture-core/wiki/Flux-user-guide).
20
+
You can `build` the stand-alone application yourself or `download` it.
20
21
21
-
1. Download the latest distribution package from the [release page](https://github.com/metafacture/metafacture-core/releases). Make sure that you do download a distribution package and *not* a source code package (the file name should include `*-dist*`).
22
+
a) Build
22
23
23
-
2. Extract the downloaded archive:
24
+
Proceed as described in [Building metafacture-core from source](#build_from_source).
25
+
26
+
b) Download
27
+
28
+
Download the latest distribution package from the [release page](https://github.com/metafacture/metafacture-core/releases). Make sure that you do download a distribution package and *not* a source code package (the file name should include `*-dist*`).
29
+
30
+
Regardless if you've build or downloaded, go on with:
31
+
32
+
1. Extract the archive:
24
33
```bash
25
34
$ tar xzf metafacture-core-$VERSION-dist.tar.gz
26
35
```
27
36
This will create a new directory containing a ready-to-use Metafacture distribution.
28
-
3. Change into the newly created directory:
37
+
2. Change into the newly created directory:
29
38
```bash
30
39
$ cd metafacture-core-$VERSION
31
40
```
32
-
4. Run one of the example scripts:
41
+
3. Run one of the example scripts:
33
42
```bash
34
43
$ ./flux.sh examples/read/marc21/read-marc21.flux
35
44
```
@@ -52,7 +61,7 @@ Alternatively, you can simply guess the package names from the top-level folders
52
61
</dependency>
53
62
```
54
63
55
-
or if Gradle is your build tool of choice use:
64
+
or if Gradle is your buildbuild_from_source tool of choice use:
56
65
57
66
```groovy
58
67
dependencies {
@@ -66,25 +75,27 @@ Occasionally, we publish snapshot builds on [Sonatype OSS Repository](https://os
66
75
TODO: Link to getting started tutorial
67
76
-->
68
77
78
+
79
+
<a name="build_from_source"></a>
69
80
# Building metafacture-core from source
70
81
71
82
Building metafacture-core from source is easy. All you need is git and JDK 8:
72
83
73
84
1. Clone the metafacture-core repository and change into the directory:
2. Invoke the Gradle wrapper to download Gradle and build metafacture-core (on Windows call `gradlew.bat publishToMavenLocal` instead):
81
-
82
-
```bash
83
-
$ ./gradlew publishToMavenLocal
84
-
```
85
-
86
-
Besides the resulting distribution in`metafacture-core/metafacture-runner/build/distributions/` this also provides builds in your local maven repository.
90
+
2. Invoke the Gradle wrapper to download Gradle and build metafacture-core (on Windows call `gradlew.bat publishToMavenLocal` instead) and publish these to your local maven repository:
91
+
```bash
92
+
$ ./gradlew publishToMavenLocal
93
+
```
87
94
95
+
3. Create a distribution if you need one. The resulting distribution can be found in`metafacture-core/metafacture-runner/build/distributions/`:
96
+
```bash
97
+
$ ./gradlew assembleDist
98
+
```
88
99
89
100
See [Code Quality and Style](https://github.com/metafacture/metafacture-core/wiki/Code-Quality-and-Style) on the wiki for further information on the sources.
0 commit comments