Merge branch 'master' of gitlab.lrz.de:hpcsoftware/teaMPI

README.md

@@ -17,8 +17,11 @@ is also compared with the other replicas.
 
 ### How do I get set up? ##
 To build the library:  
-1. Run `make` in the lib directory  
-2. set the number of teams with the `TEAMS` environment variable (default: 2)  
+1. Run `mkdir build && cd build`
+2. Run `cmake ..` in the build directory, specify compilers if needed  
+3. Run `make` in the build directory to build the shared library
+4. Set the number of teams with the `TEAMS` environment variable (default: 2) 
+5. Run the application with `mpirun -n <np*TEAMS> ./application <args>` with `np` processes per team 
 
 To use some example provided miniapps:  
 1. run `make` in the applications folder  
@@ -26,7 +29,8 @@ To use some example provided miniapps:
 
 To use with an existing application:  
 1. Link with `-ltmpi -L"path to teaMPI"`   
-2. Add "path to teaMPI" to `LD_LIBRARY_PATH`   
+2. Add "path to teaMPI" to `LD_LIBRARY_PATH` 
+3. Set `LD_PRELOAD=<path to teaMPI>/libtmpi.so`  
 
 ### Example Heartbeat Usage ###
 This application models many scientific applications. Per loop, the two `MPI_Sendrecv` calls act as heartbeats.