Commit 81076cc0 authored by Timo Koch's avatar Timo Koch
Browse files

[readme] Beautify

parent 2550309b
...@@ -5,8 +5,20 @@ This repository contains the Dockerfiles to build Docker images. The Docker ...@@ -5,8 +5,20 @@ This repository contains the Dockerfiles to build Docker images. The Docker
images can be found on the [Dumux Docker Hub](https://hub.docker.com/u/dumux/). images can be found on the [Dumux Docker Hub](https://hub.docker.com/u/dumux/).
Using these Docker images you can spin up Docker containers to run DuMux. Using these Docker images you can spin up Docker containers to run DuMux.
Running a DuMux Docker container
---------------------------------
You also can spin up a Docker container running DuMux by simly using the Docker command. However,
the expression can get quite lengthy, especially when you want to support the graphical display.
Run
```bash
docker run -it --rm --env DISPLAY=unix$DISPLAY --device /dev/dri --volume /tmp/.X11-unix:/tmp/.X11-unix:rw dumux:latest /bin/bash
```
Running with docker-compose Running with docker-compose
***************************** -------------------------------
The easiest is starting the container using docker-compose. The easiest is starting the container using docker-compose.
Create a YAML file called `docker-compose.yml` (default recognized by docker-compose) or choosing Create a YAML file called `docker-compose.yml` (default recognized by docker-compose) or choosing
...@@ -38,19 +50,8 @@ This will start a Docker container running DuMux (hopefully with graphical suppo ...@@ -38,19 +50,8 @@ This will start a Docker container running DuMux (hopefully with graphical suppo
Docker-compose will default to `docker-compose.yml` if no file is specified with the `-f` option. Docker-compose will default to `docker-compose.yml` if no file is specified with the `-f` option.
Running without docker-compose Run first DuMux program in Docker container
******************************** ---------------------------------------------
You also can spin up a Docker container running DuMux by simly using the Docker command. However,
the expression can get quite lengthy, especially when you want to support the graphical display.
Run
```bash
docker run -it --rm --env DISPLAY=unix$DISPLAY --device /dev/dri --volume /tmp/.X11-unix:/tmp/.X11-unix:rw dumux:latest /bin/bash
```
Run first DuMux program
*************************
To run your first DuMux application change the directory by running To run your first DuMux application change the directory by running
```bash ```bash
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment