Unify READMEs and travis

Author: Ithanil

.travis.yml

@@ -49,7 +49,8 @@ before_install:
   fi;
   echo "CXX_COMPILER=${MYCXX}" >> config.sh;
   echo "CXX_FLAGS=\"-O0 -g -Wall -Wno-unused-function ${configopt}\"" >> config.sh;
-  if [[ "$USE_GCOV" == "TRUE" ]]; then echo "USE_COVERAGE=1" >> config.sh;
+  if [[ "$USE_GCOV" == "TRUE" ]];
+  then echo "USE_COVERAGE=1" >> config.sh;
   else
   echo "USE_COVERAGE=0" >> config.sh;
   fi;
@@ -64,15 +65,15 @@ script:
 - |
   if [[ "$USE_DOCKER" == "TRUE" ]]; then
   if [[ "$USE_GCOV" == "TRUE" ]]; then
-  docker run -it -v $(pwd):/root/repo nnvmc/base /bin/bash -c "cd /root/repo/test && ./run.sh";
+  docker run -it -v $(pwd):/root/repo nnvmc/base /bin/bash -c "cd /root/repo/build && make test";
   docker run -e TRAVIS=$TRAVIS -e TRAVIS_JOB_ID=$TRAVIS_JOB_ID -it -v $(pwd):/root/repo nnvmc/base /bin/bash -c "pip install cpp-coveralls && cd /root/repo/build && coveralls --verbose -b ./ -r ../ -i include -i src -x .cpp -x .hpp --gcov-options '\-lp'";
   else
   docker run -it -v $(pwd):/root/repo nnvmc/base /bin/bash -c "cd /root/repo/test && ./run.sh";
   fi;
   else
   if [[ "$USE_GCOV" == "TRUE" ]]; then
-  cd build && make test && cd .. ;
-  pip install --user cpp-coveralls && cd build && coveralls --verbose -b ./ -r ../ -i include -i src -x .cpp -x .hpp --gcov-options '\-lp';
+  cd build && make test;
+  sudo pip install cpp-coveralls && coveralls --verbose -b ./ -r ../ -i include -i src -x .cpp -x .hpp --gcov-options '\-lp' && cd .. ;
   else
   cd test && ./run.sh && cd .. ;
   fi;

README.md

@@ -5,20 +5,44 @@
 
 # MCIntegrator++
 
-C++ Library for computing numerical integrals with the Monte Carlo method.
-Some basic tools for finding the average and standard deviation of an array of data are included.
+C++ Library for computing numerical integrals with the Monte Carlo method. Includes some convenient
+(optional) methods for automatic step calibration, decorrelation and error estimation. Provides a simple
+interface to execute the MC integration in parallel, via Message Passing Interface (MPI).
 
-In `doc/` there is a user manual in pdf.
+In `doc/` there is a user manual in pdf and a config for doxygen.
 
-In `examples/` there are examples.
+In `examples/` and `test/` there are examples and tests for the library.
 
+In `res/` we provide a true random seed file.
+
+
+Some subdirectories come with an own `README.md` file which provides further information.
+
+
+# Supported Systems
+
+Currently, we automatically test the library on Arch Linux (GCC 8) and MacOS (with clang as well as brewed GCC 8).
+However, in principle any system with C++11 supporting compiler should work.
+
+
+# Requirements
+
+- CMake, to use our build process
+- (optional) a MPI implementation, to use parallelized integration
+- (optional) valgrind, to run `./run.sh` in `test/`
+- (optional) pdflatex, to compile the tex file in `doc/`
+- (optional) doxygen, to generate doxygen documentation in `doc/doxygen`
 
 
 # Build the library
 
-We use the CMake build system, so you need to have it on your system to build the library out of the box.
-Then copy the file `config_template.sh` to `config.sh`, edit it to your liking and then simply execute the command
+Copy the file `config_template.sh` to `config.sh`, edit it to your liking and then simply execute the command
 
    `./build.sh`
 
 Note that we build out-of-tree, so the compiled library and executable files can be found in the directories under `./build/`.
+
+
+# First steps
+
+You may want to read `doc/user_manual.pdf` to get a quick overview of the libraries functionality. However, it is not guaranteed to be perfectly up-to-date and accurate. Therefore, the best way to get your own code started is by studying the examples in `examples/`. See `examples/README.md` for further guidance.

examples/README.md

@@ -1,5 +1,8 @@
 # LEGEND OF THE EXAMPLES
 
+Make sure the examples are compiled, by running `./build.sh` in the project root folder.
+Execute an example by switching into one of the example folders and running `./run.sh`.
+Note that the actual example executables reside inside the `build/examples/` folder under the project's root.
 
 
 ## Example 1

test/README.md

@@ -1,14 +1,19 @@
 # LEGEND OF THE UNIT TESTS
 
+Use `./run.sh` inside the test directory to run the check program and unit tests
+with valgrind or use `make test` inside the build directory, to run unit tests without valgrind.
+
 
 ## Unit Test 1
 
 `ut1/`: check that calling the integrator again without doing the findMRT2step and initialDecorrelation gives the same results.
 
+
 ## Unit Test 2
 
 `ut2/`: Like ut1, but with one one-dimensional and one three-dimensional observable.
 
+
 ## Unit Test 3
 
 `ut3/`: Like ut1, but checking with fixed number of findMRT2step/decorrelation steps and fixed blocking technique