Commit 440cf1cc authored by Praetorius, Simon's avatar Praetorius, Simon
Browse files

Preparation of install instructions in the README.md

parent eee37c41
Preparing the Sources
=========================
Additional to the software mentioned in README you'll need the
following programs installed on your system:
The project *dune-amdis* requires a modern compiler supporting c++14 standard
and an up-to-date cmake >= 3.1 installed on the system.
cmake >= 2.8.12
Installation using dune-docker
------------------------------
Getting started
---------------
The easyest way to compile and run the code is to use the prepared docker images.
Therefore, 1. install *docker*, 2. clone the project *dune-docker*, 3. create the
image `dune:git`, 4. run this docker image with interactive shell.
(See also the `README.md` in the *dune-docker* project for details).
If these preliminaries are met, you should run
Prepare for installation
------------------------
dunecontrol all
In order to resolve external dependencies, run the script `contrib/ci-setup`. This
will download the latest MTL4 library (and maybe more).
which will find all installed dune modules as well as all dune modules
(not installed) which sources reside in a subdirectory of the current
directory. Note that if dune is not installed properly you will either
have to add the directory where the dunecontrol script resides (probably
./dune-common/bin) to your path or specify the relative path of the script.
Compile and link the library and examples
-----------------------------------------
Most probably you'll have to provide additional information to dunecontrol
(e. g. compilers, configure options) and/or make options.
Simply run
The most convenient way is to use options files in this case. The files
define four variables:
```
dunecontrol --opts=/duneci/opts.gcc --current all
```
CMAKE_FLAGS flags passed to cmake (during configure)
MAKE_FLAGS flags passed to make
An example options file might look like this:
#use this options to autogen, configure and make if no other options are given
CMAKE_FLAGS=" \
-DCMAKE_CXX_COMPILER=g++-4.9 \
-DCMAKE_CXX_FLAGS='-Wall -pedantic' \
-DCMAKE_INSTALL_PREFIX=/install/path" #Force g++-4.9 and set compiler flags
MAKE_FLAGS=install #Per default run make install instead of simply make
If you save this information into example.opts you can pass the opts file to
dunecontrol via the --opts option, e. g.
dunecontrol --opts=example.opts all
More info
---------
See
dunecontrol --help
for further options.
The full build-system is described in the dune-common/doc/buildsystem (Git version) or under share/doc/dune-common/buildsystem if you installed DUNE!
to build the library and to compile and link the examples from the `src/` directory.
\ No newline at end of file
Supports Markdown
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