Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
list the new examples in the doc
[simgrid.git] / examples / s4u / README.doc
index 6aaef6a..9cdcf7a 100644 (file)
@@ -14,18 +14,35 @@ documentation, but it should remain readable directly.
  @brief Find the S4U example fitting your needs in the archive.
 
   - @ref s4u_ex_basics
-                   
-@section s4u_ex_basics Basic examples and features
+  - @ref s4u_ex_synchro
+
+@section s4u_ex_basics Basics of SimGrid simulation
+
+  - <b>Launching actors:</b> @ref examples/s4u/launching/s4u_launching.cpp and 
+    @ref examples/s4u/launching/deployment.xml \n
+    Shows how to start your actors to populate your simulation.
+
+  - <b>Token ring:</b> @ref examples/s4u/app-token-ring/s4u_app-token-ring.cpp \n
+    Shows how to implement a classical communication pattern, where a token is exchanged along a ring to reach every
+    participant.
+
+  - <b>Master Workers:</b> @ref examples/s4u/app-token-ring/s4u_app-token-ring.cpp \n
+    Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker 
+    processes. 
 
 @section s4u_ex_synchro Inter-Actor Synchronization 
 
- - <b>Mutex</b>.
-   @ref examples/s4u/mutex/s4u_mutex.cpp\n
-   Shows how to use simgrid::s4u::Mutex synchronization objects
-                        
+ - <b>Mutex: </b> @ref examples/s4u/mutex/s4u_mutex.cpp \n
+   Shows how to use simgrid::s4u::Mutex synchronization objects.
+   
 */
 
 /**
+@example examples/s4u/launching/s4u_launching.cpp
+@example examples/s4u/app-token-ring/s4u_app-token-ring.cpp
+@example examples/s4u/app-master-worker/s4u_app-master-worker.cpp
+@example examples/s4u/launching/deployment.xml
+
 @example examples/s4u/mutex/s4u_mutex.cpp
 
 */
\ No newline at end of file