Readme files explaining examples and the directory hierarchy.

git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@3810 48e7efb5-ca39-0410-a469-dd3cf9ba447f

diff --git a/examples/msg/README b/examples/msg/README
new file mode 100644 (file)
index 0000000..ca09f49
--- /dev/null
+++ b/examples/msg/README
@@ -0,0 +1,175 @@
+
+
+Examples containing in this directory
+
+
+
+===============================================================================
+* sendrecv/sendrecv.c           
+OLD NAME: ping_pong.c
+===============================================================================
+
+
+    - Description:
+    Simple sendrecv example to switch network model
+
+    - Platform Files:
+    sendrecv/platform_sendrecv.xml
+       
+    - Deployment Files:
+    sendrecv/deployment_sendrecv.xml
+
+    - Compile: 
+    (WARNING: the current directory must be examples/msg/)
+    make sendrecv/sendrecv
+
+    - Execute:
+    sendrecv/sendrecv <platformfile.xml> <deploymentfile.xml> <networkmodel>
+    where networkmodel can be one of the following:
+        1) KFCCNL05              - Maxmin fairness
+        2) KFCCNL05_proportional - Vegas TCP fairness (proportional approach)
+        3) KFCCNL05_Vegas        - Vegas TCP fairness (lagrange approach)
+        4) KFCCNL05_Reno         - Reno  TCP fairness (lagrange approach)
+
+    - Debug: 
+    (WARNING: way may want to disable compiler optimizations)
+    libtool --mode=execute gdb --args sendrecv/sendrecv <parameters>
+
+    - More info:
+    sendrecv/README
+
+
+
+===============================================================================
+* masterslave/masterslave.c
+OLD NAME: msg_test_communication_time.c
+===============================================================================
+
+
+    - Description:
+    Simple master/slave application
+    
+    - Platform Files:
+    small_platform.xml    
+       
+    - Deployment Files:
+    masterslave/deployment_masterslave.xml
+
+    - Compile: 
+    (WARNING: the current directory must be examples/msg/)
+    make masterslave/masterslave
+
+    - Execute:
+    masterslave/masterslave <platformfile.xml> <deploymentfile.xml>        
+
+
+
+===============================================================================
+* masterslave/masterslave_forwarder.c
+OLD NAME: msg_test.c
+===============================================================================
+
+
+    - Description:
+    Simple master/slave application using a forwarder module
+    
+    - Platform Files:
+    msg_platform.xml    
+       
+    - Deployment Files:
+    masterslave/deployment_masterslave_forwarder.xml
+
+    - Compile: 
+    (WARNING: the current directory must be examples/msg/)
+    make masterslave/masterslave_forwarder
+
+    - Execute:
+    masterslave/masterslave_forwarder <platformfile.xml> <deploymentfile.xml>      
+
+
+===============================================================================
+* masterslave/masterslave_bypassed.c
+OLD NAME: msg_test_surfxml_bypassed.c
+===============================================================================
+
+    - Description:
+    The same master/slave example without using the xml parser.
+
+    - Platform Files:
+    NONE    
+       
+    - Deployment Files:
+    NONE
+
+    - Compile: 
+    (WARNING: the current directory must be examples/msg/)
+    make masterslave/masterslave_bypassed
+
+    - Execute:
+    masterslave/masterslave_bypassed
+   
+
+===============================================================================
+* suspend/suspend.c
+OLD NAME: msg_test_test_suspend.c
+===============================================================================
+
+
+    - Description: 
+    Test the suspend (MSG_process_suspend) and resume (MSG_process_resume)
+    msg features.
+    
+    - Platform Files:
+    msg_platform.xml
+       
+    - Deployment Files:
+    suspend/deployment_suspend.xml
+
+    - Compile: 
+    (WARNING: the current directory must be examples/msg/)
+    make suspend/suspend 
+
+    - Execute:
+    suspend/suspend <platformfile.xml> <deploymentfile.xml>
+
+
+
+
+===============================================================================
+CHANGE LOG
+===============================================================================
+
+original file                              new file
+
+
+SEND/RECV EXAMPLE
+
+./ping_pong.c             ./sendrecv/sendrecv.c
+
+MASTER/SLAVE FORWARDER
+
+./msg_test.c              ./masterslave/masterslave_forwarder.c
+./msg_deployment.xml      ./masterslave/deployment_masterslave_forwarder.xml
+./msg_test.tesh.in        ./masterslave/masterslave_forwarder.tesh.in
+
+MASTER/SLAVE SIMPLE
+
+./msg_test_communication_time.c        ./masterslave/masterslave.c
+./small_deployment.xml                 ./masterslave/deployment_masterslave.xml
+./msg_test_communication_time.tesh.in  ./masterslave/masterslave.tesh.in
+
+MASTER/SLAVE BYPASS
+
+./msg_test_surfxml_bypassed.c ./masterslave/masterslave_bypass.c
+./flexml_bypass.tesh.in       ./masterslave/masterslave_bypass.tesh.in
+
+
+SUSPEND
+
+./msg_test_test_suspend.c     ./suspend/suspend.c
+                              ./suspend/deployment_suspend.xml
+./suspend.tesh.in             ./suspend/suspend.tesh.in
+
+
+
+