Commit 40ef9f03 authored by Lukas Riedel's avatar Lukas Riedel

added instructions for using Docker

parent ff8f324c
......@@ -3,6 +3,41 @@
[![build status](http://shangrila.iup.uni-heidelberg.de:30000/ci/projects/1/status.png?ref=master)](http://shangrila.iup.uni-heidelberg.de:30000/ci/projects/1?ref=master)
## Installation Instructions
DORiE is a [DUNE](https://dune-project.org/) module and requires several other DUNE modules as well as third party software packages. Installation can be handled manually on your local machine, but it's recommended to use the virtualization software [Docker](https://www.docker.com/) instead.
In any case, DORiE is configured, build, and installed via the [DUNE Buildsystem](https://dune-project.org/doc/installation/), using the `dunecontrol` script to handle DUNE-internal dependencies.
### Docker Installation
Install Docker on your machine. Then, download the [DORiE DUNE Environment Repository](https://hub.docker.com/r/dorie/dune-env/) from [Dockerhub](https://hub.docker.com/), by executing
docker pull dorie/dune-env
Run a new container from the v2.4 image by calling
docker run -i -t dorie/dune-env:2.4 /bin/bash
Additionally, use the `-v` option of the `run` command to mount a local directory into the container:
-v <hostdir/dorie>:/opt/dune/dorie
This way, you can access the content of the (still empty) folder of the virtual machine from your local `<hostdir>/dorie` directory.
Next, `git clone` the DORiE repository into the shared folder. Enter the container, and execute
dunecontrol --only=dorie all
to build DORiE.
#### Update DUNE
The DUNE modules in the repository might be outdated. You can update to the newest versions by calling
dunecontrol update
Then compile all modules again by executing
dunecontrol all
## Quick installation
More comprehensive installation instructions of the current `master` branch can be found [in the online documentation](http://dorie-docs.gitballoon.com) (password: `richards`).
......
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