Skip to content

Commit

Permalink
Merge pull request #18 from music-encoding/fix/readme-lang
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
musicEnfanthen authored Jun 15, 2023
2 parents 45e0d4d + b01174e commit a15eb11
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ The image is being published on the GitHub Container Registry (ghcr.io).
The following examples use different Docker commands. Detailed explanations of these Docker commands can be found in the [Docker Command-line reference](https://docs.docker.com/engine/reference/run/) but here’s a concise explanation:

| Command Particle | Description |
|------------------|-------------|
|------------------|-------------|
| [Running a container] | |
| `docker run` | Runs a docker process as an isolated container. Must specify an image to derive the container from. |
| `--rm` | Automatically clean up the Docker container and remove the file system when the container exits. |
| `-it` | Open an interactive shell. |
| `-v` (or `--volume`) | mount a folder from the host as a volume in the Docker container, here the current working directory (`pwd`) gets mounted into `/opt/docker-mei/music-encoding` in the docker container |
| `--name` | (optional) Identify the container with a local name. If not given, Docker generates a random string name. |
| `--name` | (optional) Identify the container with a local name. If not given, Docker generates a random string name. |
| `ghcr.io/music-encoding/docker-mei:latest` or `docker-mei:local` | The Docker image (latest version) to be used and pulled, wether from a remote registry like ghcr.io or a local build process. |
| `ant -noinput -buildfile music-encoding/build.xml` | Execute ant with the build.xml file of the music-encoding repo. |
| `-Ddocker=true` | A flag to indicate that ant is triggered via Docker. |
| [Building an image] | |
| `docker buildx build` | Builds a Docker image from a Dockerfile. If not specified, the file is assumed to be in the current working directory. |
| `-t` | Allows to specify some name and optional tag for the Docker image to be built, e.g., `docker-mei:local` |
| `-t` | Allows to specify some name and optional tag for the Docker image to be built, e.g., `docker-mei:local` |


### Pulling the Docker image
Expand Down Expand Up @@ -66,13 +66,13 @@ For example, if you start the Docker image from the root folder of your music-en
docker run --rm -it -v `pwd`:/opt/docker-mei/music-encoding --name docker-mei ghcr.io/music-encoding/docker-mei:latest
```

This will open a shell prompt at the root folder of the container (`/opt/docker-mei`). In order to proceed building mei assets, you will need to navigate to the sub folder `music-encoding`.
This will open a shell prompt at the root folder of the container (`/opt/docker-mei`). In order to proceed with building mei assets, you will need to navigate to the subfolder `music-encoding`.

```bash
cd music-encoding
```

From here you can enter the corresponding commands, as found in the [build.xml](https://github.com/music-encoding/music-encoding/blob/develop/build.xml) file of the [music-encoding repository ](https://github.com/music-encoding/music-encoding), on the command line.
From here you can enter the corresponding commands, as found in the [build.xml](https://github.com/music-encoding/music-encoding/blob/develop/build.xml) file of the [music-encoding repository](https://github.com/music-encoding/music-encoding), on the command line.

For example:

Expand All @@ -95,13 +95,13 @@ Clone the repository to your machine, e.g., via the command line:
1. Navigate to the parent directory where you want your clone to live, e.g.:

```bash
cd /temp/
cd /temp/
```

2. Clone the repository:

```bash
git clone https://github.com/music-encoding/docker-mei.git
git clone https://github.com/music-encoding/docker-mei.git
```

3. Navigate to the new repository clone’s root directory:
Expand All @@ -128,4 +128,7 @@ Clone the repository to your machine, e.g., via the command line:
docker run --rm -v [/ABSOLUTE/PATH/TO/YOUR/MUSIC_ENCODING/CLONE]:/opt/docker-mei/music-encoding --name docker-mei [some-name-tag]
```

N.B.: Before executing the above command, replace the _[SQUARE-BRACKETS]_ with your local variables.
N.B.: Before executing the above command, replace the _[SQUARE-BRACKETS]_ with your local variables. For example, if you start your local Docker image from the root folder of your music-encoding repository clone:
```bash
docker run --rm -v `pwd`:/opt/docker-mei/music-encoding --name docker-mei docker-mei:local
```

0 comments on commit a15eb11

Please sign in to comment.