Skip to content

Commit

Permalink
Adding a simple README
Browse files Browse the repository at this point in the history
  • Loading branch information
kallewesterling committed Jul 9, 2024
1 parent 75d0f04 commit d03f990
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# MapReader Examples

A containerised application for testing out the MapReader library.

## Creating the Docker image

To create the Docker image, run the following command:

```bash
docker build -t mapreader-examples .
```

Note: This will take a while to complete as maps will be downloaded from the
NLS. In our current tests, it takes ~30-35 minutes to complete.

## Running the Docker container

To run the Docker container, run the following command:

```bash
docker run -p 8888:8888 mapreader-examples
```

## Running the Docker container from Docker Hub

To run the Docker container from Docker Hub, run the following command:

```bash
docker run -p 8888:8888 kallewesterling/mapreader-examples
```

0 comments on commit d03f990

Please sign in to comment.