22
33## Prerequesites
44
5- * a recent C++ compiler, which supports most of the C++11 features
6- * the [ CMake] ( http://cmake.org/ ) build tool
5+ * A recent C++ compiler that supports ( most of) the C++11 standard.
6+ * The [ CMake] ( http://cmake.org/ ) build tool.
77
88
99## Obtaining the Sources
@@ -13,32 +13,40 @@ Just use _Git_ to clone the repository.
1313
1414## Building
1515
16- 1 . create a directory for out-of-source builds (usually, people are creative and name it ` build ` ) in the source tree
17- 2 . decide on what you want to build
18-
19- By default everythin gets build, i.e. tests and examples.
20-
21- To deactive the tests pass ` -Dpfasst_BUILD_TESTS=OFF ` to the _ CMake_ command line.
22-
23- To deactive the examples, pass ` -Dpfasst_BUILD_EXAMPLES=OFF ` to the _ CMake_ command line.
24-
25- If you are not on a _ Darvin_ system (i.e. MacOS, OSX, ...) and you are using _ Clang_ as the
26- compiler, you want to deactive the use of LLVM's libc++ by passing ` -Dpfasst_DISABLE_LIBCXX=ON `
27- to the _ CMake_ command line.
28-
29- In the end, for a build with _ Clang_ on a Linux system without the examples, the call to _ CMake_
30- looks like:
31-
16+ 1 . Create a directory for out-of-source builds (usually, people are
17+ creative and name it ` build ` ) in the source tree (or elsewhere).
18+
19+ 2 . Decide on what you want to build:
20+
21+ * By default everything gets built, i.e. tests and examples.
22+
23+ * To deactivate the tests, pass ` -Dpfasst_BUILD_TESTS=OFF ` to the
24+ _ CMake_ command line.
25+
26+ * To deactivate the examples, pass ` -Dpfasst_BUILD_EXAMPLES=OFF ` to
27+ the _ CMake_ command line.
28+
29+ * If you are not on a _ Darvin_ system (i.e. MacOS, OSX, ...) and
30+ you are using _ Clang_ as the compiler, you want to deactivate the
31+ use of LLVM's libc++ by passing ` -Dpfasst_DISABLE_LIBCXX=ON ` to
32+ the _ CMake_ command line.
33+
34+ * For example, to build with _ Clang_ on a Linux system without the
35+ examples, the call to _ CMake_ looks like:
36+
3237 cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -Dpfasst_DISABLE_LIBCXX=ON -Dpfasst_BUILD_EXAMPLES=OFF ..
3338
34- As the [ Google Testing] and [ Mocking Framework] are required for the unit tests, those are automatically
35- downloaded and build.
36-
37- In case, you enable the examples, [ FFTW3] gets downloaded and build as well.
38- 3 . run the unit tests (if unit tests have been built)
39+ The [ Google Testing] and [ Mocking Framework] are required for the
40+ unit tests, and are automatically downloaded and built.
41+
42+ The [ FFTW3] library is required for (some) of the examples, and it
43+ automatically downloaded and built as well.
44+
45+ 3 . Run the unit tests (if unit tests have been built):
3946
4047 make test
41- 4 . run the examples (if those have been built). e.g.:
48+
49+ 4 . Run the examples (if they have been built):
4250
4351 ./examples/advection
4452
0 commit comments