Update README.md

kennethassogba · Apr 6, 2023 · 2dfd1c7 · 2dfd1c7
1 parent e67b99a
commit 2dfd1c7
Showing 1 changed file with 11 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -2,14 +2,6 @@
 
 A vanilla header-only object oriented interface around MPI in C++.
 
-## Build
-```bash
-mkdir build; cd build
-cmake ..
-make -j
-./usage
-```
-
 ## Usage
 ```c++
 #include "human/mpi.hpp"
@@ -30,21 +22,30 @@ std::cout << "P" << rank << " " << msg << std::endl;
 world.display(); // display time table
 ```
 
+## Build an example
+```bash
+mkdir build; cd build
+cmake ..
+make -j
+./usage
+```
+
 ## Features
 - Send `vector` and `string` with automatic resize
 - Time events and display time table
+- Not exhaustive but simple to extend
 
 ## Macro
 - -DUSE_HUMAN_MPI use the lib
 - -DHUMAN_MPI_TIMER_USE_MPI=false use chrono
 - -DHUMAN_MPI_TIMER_FOR_REAL=false disable timing
 
 ## Roadmap
+- Add mpi request in human::mpi
 - Write tests
 - Add multiple executable in Cmake
-- Github action for ci cd
+- Configure Github action
 - Simple Doc
-- Write docker file
 
 ## Write
 - Developping an interface around MPI