Commit 5a319ddb authored by Dion Häfner's avatar Dion Häfner

Minor fixes

parent 74cf2551
......@@ -25,14 +25,14 @@ Install Docker on your machine. Then, use `git clone` to download the DORiE repo
Docker will use a prepared image from Dockerhub and install DORiE into it. You can now call DORiE via the Docker deamon from any directory `dir` on your machine:
docker run -i -t -v <dir>:/sim dorie dorie <command>
docker run -i -t -v <dir>:/sim dorie <command>
The `-v` option tells docker to mount the directory into the container work directory (`sim`).
In the section 'Usage' you will find a list of possible commands. Notice that input and output files can only be placed in the `<dir>` directory or subdirectories thereof. You must use relative paths in the DORiE configuration files.
In the section 'Usage' you will find a list of possible commands. Note that input and output files can only be placed in the `<dir>` directory or subdirectories thereof. You must use relative paths in the DORiE configuration files.
## Docker Installation - Interactive Setup
This setup is intended for advanced users. You will gain access to the DORiE module outside the container.
This setup is intended for advanced users. You will gain access to the DORiE module outside the container, and be able to make changes to the source code.
We have prepared a [DORiE DUNE Environment Image on Dockerhub](https://hub.docker.com/r/dorie/dune-env/), which is a modified image of the Ubuntu OS that has all dependencies readily installed. The current version is 2.4 (referencing the DUNE module version 2.4).
Run a new container from this image by calling
......@@ -64,7 +64,9 @@ Then compile and install all modules again by executing
## Manual Installation
Installing all packages manually can be quite an effort, but useful for developers who want to easily access documentation material and source files of the dependency packages. Whenever possible, dependencies should be installed using a package manager, like [APT](https://wiki.ubuntuusers.de/APT/) on Ubuntu or [Homebrew](http://brew.sh/) on Mac. Manual installation on a Windows environment is strongly discouraged!
Installing all packages manually can be quite an effort, but useful for developers who want to have easy access to the source files or users who prefer to run DORiE without the Docker overhead.
Whenever possible, dependencies should be installed using a package manager, like [APT](https://wiki.ubuntuusers.de/APT/) on Ubuntu or [Homebrew](http://brew.sh/) on Mac. Manual installation on a Windows environment is strongly discouraged!
### Dependencies
Depending on your system configuration, there will be more packages necessary to install DORiE on your machine. See the step-by-step manual for further details.
......@@ -96,7 +98,7 @@ Depending on your system configuration, there will be more packages necessary to
If you also want to build the documentation, you will additionally need to install Doxygen, Sphinx and Breathe.
### Step-by-step Instructions
These instructions are suitable for a clean **Ubuntu** or **Mac OS X** setup. The main difference between the two systems is the package manager. Ubuntu has the APT manager already built in. On Mac, we recommend installing [Homebrew](http://brew.sh/). If you must use [MacPorts](https://www.macports.org/), you need to check if some of the packages require different installation options than displayed here.
These instructions are suitable for a clean **Ubuntu** or **Mac OS X** setup. The main difference between the two systems is the package manager. Debian-based systems have the APT manager already built in. On Mac, we recommend installing [Homebrew](http://brew.sh/). If you prefer to use [MacPorts](https://www.macports.org/), you need to check if some of the packages require different installation options than displayed here.
1. Install third party packages:
......@@ -127,7 +129,7 @@ These instructions are suitable for a clean **Ubuntu** or **Mac OS X** setup. Th
export CC=gcc-6
export CXX=g++-6
to enfore the Homebrew'd GCC compiler. Notice that this variable export only lasts for your current terminal session. Always make sure that the configuration tool actually finds GCC instead of the Apple Clang.
to enfore the Homebrew'd GCC compiler. Note that this variable export only lasts for your current terminal session. Always make sure that the configuration tool actually finds GCC instead of the Apple Clang.
2. Avoid the Apple Python 2 interpreter, located in `/usr/bin`. dune-python searches for and binds to the symlink `python` first. If you did **not** install a custom Python 2 interpreter, create a dummy symlink in the `/usr/local/bin` directory:
......@@ -196,11 +198,11 @@ to execute the main program.
List all available commands and find further help by executing
dorie help
dorie --help
or
dorie <command> -h
dorie <command> --help
## Troubleshooting
CMake heavily caches the results of its configuration process. In case you encounter errors or strange behavior, especially after an update, you should delete the DORiE build folder (called `build-cmake` by default) and re-install DORiE using `dunecontrol`.
......@@ -225,11 +227,7 @@ A debugger needs special security privileges usually not provided by the Docker
--security-opt seccomp=unconfined
The prepared Docker image does not contain a debugger. You can install GDB by calling
apt install gdb
inside the running container.
The debugger `gdb` is pre-installed in the Docker container.
### DORiE is running, but I suspect that something is wrong
You can execute system tests in order to ensure that DORiE is running correctly and producing the expected results:
......
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