Skip to content

Commit

Permalink
Merge pull request #2 from musicEnfanthen/fix-readme
Browse files Browse the repository at this point in the history
Fix readme
  • Loading branch information
riedde authored Dec 2, 2022
2 parents f5b574f + b589fb3 commit fa23b92
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
# docker-mei

A docker image for anything concerning MEI.
Docker images for anything concerning the MEI build process.

The repository contains two Dockerfiles:

- `Dockerfile.base`: creates a basic image with all necessary dependencies (Saxon, Ant, Verovio, Prince)
- `Dockerfile`: creates an executing image that allows running different MEI build steps (incl. building schema, customizations, or guidelines)

## Local build of basic image

## Local build basic image
```docker build -f Dockerfile.base -t docker-mei-base . ```

## Local build executive image
## Local build of executing image

```docker build -t docker-mei .```

## Exampl usage (without local build)
## Example usage (without local build)

tbc.

## Exampl usage (local build)
## Example usage (local build)

```docker run --rm -v /ABSOLUTE/PATH/TO/YOUR/MUSIC_ENCODING/CLONE:/opt/music-encoding --name docker-mei docker-mei```

0 comments on commit fa23b92

Please sign in to comment.