Skip to content

Commit ee1a566

Browse files
committed
Add quickstart description to readme
1 parent dbe0e21 commit ee1a566

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,23 @@
1-
metafacture-runner
2-
==================
1+
# metafacture-runner #
32

4-
Standalone applications for working with Flux and Metamorph scripts
3+
Standalone commandline applications for working with Flux and Metamorph scripts
4+
5+
## Quickstart ##
6+
7+
1. Download the latest distribution package from [the metafacture-runner/releases](https://github.com/culturegraph/metafacutre-runner/releases) page. Make sure that you do download a distribution package and _not_ a source code package. The latest distribution package is [metafacture-runner 3.1.1](https://github.com/culturegraph/metafacture-runner/releases/download/metafacture-runner-3.1.1/metafacture-runner-3.1.1-dist.tar.gz).
8+
2. Extract the downloaded archive:
9+
```bash
10+
$ tar xzf metafacture-runner-3.1.1-dist.tar.gz
11+
```
12+
This will create a new directory containing a ready-to-use metafacture distribution.
13+
3. Change into the newly created directory:
14+
```bash
15+
$ cd metafacture-runner-3.1.1
16+
```
17+
4. Run one of the example scripts:
18+
```bash
19+
$ ./flux.sh examples/read/marc21/read-marc21.flux
20+
```
21+
This example will print a number of marc21 records on standard out.
22+
23+
The _examples_ folder contains many more examples which provide a good starting point for learning metafacture. If you have any questions please join our [mailing list](http://lists.dnb.de/mailman/listinfo/metafacture) or use our issue-based discussion forum over at [metafacture-documentation](https://github.com/culturegraph/metafacture-documentation).

0 commit comments

Comments
 (0)