The TS-GitLab will have to shut down towards the end of the year — please think about migrating your projects to GitLab.com or GitHub.
(This is still a very early message, meant to keep you informed. There will be more urgent ones in the future.)

Commit 049f266d authored by Lukas Riedel's avatar Lukas Riedel
Browse files

Merge branch 'update-readme' into 'master'

Update readme

See merge request !123
parents 9390c2af 76dc846e
...@@ -63,7 +63,7 @@ by CI tests. ...@@ -63,7 +63,7 @@ by CI tests.
| Software | Version/Branch | Comments | | Software | Version/Branch | Comments |
| ---------| -------------- | -------- | | ---------| -------------- | -------- |
| CMake | 3.10.2 | | CMake | 3.10.2 |
| GCC | 7.3 | Alternatively: LLVM Clang >=6 | GCC | 7.3 | Alternatively: LLVM Clang >=6, or Apple Clang 10
| git | | git |
| pkg-config | | pkg-config |
| HDF5 | 1.10 | with MPI support | HDF5 | 1.10 | with MPI support
...@@ -103,6 +103,8 @@ If you installed [Anaconda](https://conda.io/docs/user-guide/install/download.ht ...@@ -103,6 +103,8 @@ If you installed [Anaconda](https://conda.io/docs/user-guide/install/download.ht
1. **macOS** users need to start by installing the Apple Command Line Tools by executing 1. **macOS** users need to start by installing the Apple Command Line Tools by executing
xcode-select --install xcode-select --install
Make sure you have no pending software updates for your respective version of macOS!
2. Install third party packages: 2. Install third party packages:
...@@ -149,8 +151,6 @@ If you installed [Anaconda](https://conda.io/docs/user-guide/install/download.ht ...@@ -149,8 +151,6 @@ If you installed [Anaconda](https://conda.io/docs/user-guide/install/download.ht
to build all DUNE modules. Additionally, you can add `MAKE_FLAGS="-j X"` before the call to `dunecontrol` to compile on `X` processes in parallel. to build all DUNE modules. Additionally, you can add `MAKE_FLAGS="-j X"` before the call to `dunecontrol` to compile on `X` processes in parallel.
**Warning:** Users of **macOS** with Apple Clang version >=10 need to append `-DDUNE_HAVE_CXX_OPTIONAL=Off` to the `CMAKE_FLAGS`.
If you installed software into paths not appended to your `PATH` variable, you will have to add `CMAKE_FLAGS` to the call to make sure that CMake finds all packages. Alternatively, you can add a custom options file. See the [DUNE Installation Instructions](https://dune-project.org/doc/installation/) for details. CMake will throw an error if required packages are not found. If you installed software into paths not appended to your `PATH` variable, you will have to add `CMAKE_FLAGS` to the call to make sure that CMake finds all packages. Alternatively, you can add a custom options file. See the [DUNE Installation Instructions](https://dune-project.org/doc/installation/) for details. CMake will throw an error if required packages are not found.
**Warning:** Anacoda supplies its own version of HDF5 which is typically found first by CMake. If you have Anaconda installed on your machine, add **Warning:** Anacoda supplies its own version of HDF5 which is typically found first by CMake. If you have Anaconda installed on your machine, add
...@@ -309,8 +309,8 @@ it is recommended to build them in a `Release` environment. ...@@ -309,8 +309,8 @@ it is recommended to build them in a `Release` environment.
| Test category | Build tests | Execute tests | Recommended build type | | Test category | Build tests | Execute tests | Recommended build type |
| ------------- | ----------- | ------------- | ---------------------- | | ------------- | ----------- | ------------- | ---------------------- |
| Unit tests | `make build_unit_tests` | `make_unit_tests` | `Debug` | Unit tests | `make build_unit_tests` | `make unit_tests` | `Debug`
| System tests | `make build_system_tests` | `make_system_tests` | `Release` | System tests | `make build_system_tests` | `make system_tests` | `Release`
The `make` commands are to be executed from within the `build-cmake` directory. The `make` commands are to be executed from within the `build-cmake` directory.
......
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