Skip to content

Commit 8bb0808

Browse files
committed
Update README.
- Spelling, formatting, URLs. - Fixed statement about automatic snapshot builds (cf. #411).
1 parent b5abc5b commit 8bb0808

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,63 +4,63 @@
44

55
Metafacture is a toolkit for processing semi-structured data with a focus on library metadata. It provides a versatile set of tools for reading, writing and transforming data. Metafacture can be used as a stand-alone application or as a Java library in other applications. The name Metafacture is a portmanteau of the words *meta*data and manu*facture*.
66

7-
Metafacture includes a [large number of modules](https://github.com/metafacture/metafacture-documentation/blob/master/flux-commands.md) for operating on semi-structured data. These modules can be combined to build pipelines to perform complex metadata processing tasks. The pipelines can be constructed either in Java code or with the domain-specific language **Flux**. One of the core features of Metafacture is the **Metamorph** module. Metamorph is an xml-based language for specifying transformations of semi-structured data. It can be seamlessly integrated into Java code.
7+
Metafacture includes a [large number of modules](https://github.com/metafacture/metafacture-documentation/blob/master/flux-commands.md) for operating on semi-structured data. These modules can be combined to build pipelines to perform complex metadata processing tasks. The pipelines can be constructed either in Java code or with the domain-specific language **Flux**. One of the core features of Metafacture is the **Metamorph** module. Metamorph is an XML-based language for specifying transformations of semi-structured data. It can be seamlessly integrated into Java code.
88

99
At its heart Metafacture is a framework for implementing modules for metadata processing. This makes Metafacture easily extendable with additional modules. The [plugins and tools page](https://github.com/metafacture/metafacture-core/wiki/Plugins-and-Tools) on the wiki shows supplementary packages and projects which extend Metafacture.
1010

11-
Originally, Metafacture was developed as part of the [Culturegraph](http://culturegraph.org) platform but it is developed independently now and used by others, too: [see who uses Metafacture](https://github.com/metafacture/metafacture-core/wiki/Who-uses-Metafacture).
11+
Originally, Metafacture was developed as part of the [Culturegraph](http://www.culturegraph.org) platform but it is developed independently now and used by others, too: [see who uses Metafacture](https://github.com/metafacture/metafacture-core/wiki/Who-uses-Metafacture).
1212

1313
# Getting started
1414

1515
You can either use Metafacture as a stand-alone application or include it as a Java library in your own projects.
1616

1717
## Metafacture as a stand-alone application
1818

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).
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).
2020

21-
1. Download the latest distribution package from the [metafacture-core/releases](https://github.com/metafacture/metafacture-core/releases) page. Make sure that you do download a distribution package and _not_ a source code package (the file name should include *-dist*).
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*`).
2222

2323
2. Extract the downloaded archive:
2424
```bash
25-
$ tar xzf metafacture-core-VERSION-dist.tar.gz
25+
$ tar xzf metafacture-core-$VERSION-dist.tar.gz
2626
```
27-
This will create a new directory containing a ready-to-use metafacture distribution.
27+
This will create a new directory containing a ready-to-use Metafacture distribution.
2828
3. Change into the newly created directory:
2929
```bash
30-
$ cd metafacture-core-VERSION
30+
$ cd metafacture-core-$VERSION
3131
```
3232
4. Run one of the example scripts:
3333
```bash
3434
$ ./flux.sh examples/read/marc21/read-marc21.flux
3535
```
36-
This example will print a number of marc21 records on standard out.
36+
This example will print a number of MARC 21 records on standard output.
3737

38-
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/metafacture/metafacture-documentation).
38+
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/metafacture/metafacture-documentation).
3939

4040

41-
## Using Metafacture as a Java libary
41+
## Using Metafacture as a Java library
4242

43-
If you want use Metafacture in your own Java projects all you need 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%7Cga%7C1%7Cg%3A%22org.metafacture%22).
43+
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).
4444

4545
Alternatively, you can simply guess the package names from the top-level folders in the source code repository -- they are the same. For instance, if you want to use Metamorph in your project, simply add the following dependency to your `pom.xml`:
4646

4747
```xml
4848
<dependency>
4949
<groupId>org.metafacture</groupId>
5050
<artifactId>metamorph</artifactId>
51-
<version>VERSION</version>
51+
<version>$VERSION</version>
5252
</dependency>
5353
```
5454

5555
or if Gradle is your build tool of choice use:
5656

5757
```groovy
5858
dependencies {
59-
implementation 'org.metafacture:metamorph:VERSION'
59+
implementation 'org.metafacture:metamorph:$VERSION'
6060
}
6161
```
6262

63-
Our integration server automatically publishes successful builds of all branches as snapshot versions on [Sonatype OSS Repository](https://oss.sonatype.org/index.html#nexus-search;quick~metafacture). The version number is derived from the branch name. Snapshot builds from the master branch always have the version "master-SNAPSHOT".
63+
Occasionally, we publish snapshot builds on [Sonatype OSS Repository](https://oss.sonatype.org/index.html#nexus-search;gav~org.metafacture~~~~). The version number is derived from the branch name. Snapshot builds from the master branch always have the version `master-SNAPSHOT`.
6464

6565
<!--
6666
TODO: Link to getting started tutorial
@@ -77,7 +77,7 @@ $ git clone https://github.com/metafacture/metafacture-core.git
7777
$ cd metafacture-core
7878
```
7979

80-
2. Invoke the gradle-wrapper to download Gradle and build metafacture-core (on Windows call `gradlew.bat install`):
80+
2. Invoke the Gradle wrapper to download Gradle and build metafacture-core (on Windows call `gradlew.bat install` instead):
8181

8282
```bash
8383
$ ./gradlew install

0 commit comments

Comments
 (0)