Skip to content

Commit 107d46f

Browse files
committed
Update README (#520)
- add how to build and use distribution - fix formatting
1 parent 366b843 commit 107d46f

File tree

1 file changed

+28
-17
lines changed

1 file changed

+28
-17
lines changed

README.md

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,28 @@ You can either use Metafacture as a stand-alone application or include it as a J
1717
## Metafacture as a stand-alone application
1818

1919
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.
2021

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
2223

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:
2433
```bash
2534
$ tar xzf metafacture-core-$VERSION-dist.tar.gz
2635
```
2736
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:
2938
```bash
3039
$ cd metafacture-core-$VERSION
3140
```
32-
4. Run one of the example scripts:
41+
3. Run one of the example scripts:
3342
```bash
3443
$ ./flux.sh examples/read/marc21/read-marc21.flux
3544
```
@@ -52,7 +61,7 @@ Alternatively, you can simply guess the package names from the top-level folders
5261
</dependency>
5362
```
5463

55-
or if Gradle is your build tool of choice use:
64+
or if Gradle is your buildbuild_from_source tool of choice use:
5665

5766
```groovy
5867
dependencies {
@@ -66,25 +75,27 @@ Occasionally, we publish snapshot builds on [Sonatype OSS Repository](https://os
6675
TODO: Link to getting started tutorial
6776
-->
6877

78+
79+
<a name="build_from_source"></a>
6980
# Building metafacture-core from source
7081

7182
Building metafacture-core from source is easy. All you need is git and JDK 8:
7283

7384
1. Clone the metafacture-core repository and change into the directory:
85+
```bash
86+
$ git clone https://github.com/metafacture/metafacture-core.git
87+
$ cd metafacture-core
88+
```
7489

75-
```bash
76-
$ git clone https://github.com/metafacture/metafacture-core.git
77-
$ cd metafacture-core
78-
```
79-
80-
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+
```
8794

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+
```
8899

89100
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.
90101

0 commit comments

Comments
 (0)