tuto-s4u: explain how to use Docker

[simgrid.git] / docs / source / install_yours.rst

diff --git a/docs/source/install_yours.rst b/docs/source/install_yours.rst
index d5e556d..2258c4c 100644 (file)
--- a/docs/source/install_yours.rst
+++ b/docs/source/install_yours.rst
@@ -9,6 +9,18 @@ Instead, you should create your own working directory somewhere on
 your disk (say `/home/joe/MyFirstScheduler/`), and write your code in
 there. 
 
 your disk (say `/home/joe/MyFirstScheduler/`), and write your code in
 there. 
 

+Cloning a Template Project for S4U
+----------------------------------
+
+If you plan to use the modern S4U interface of SimGrid, the easiest is
+to clone the `Template Project
+<https://framagit.org/simgrid/simgrid-template-s4u>`_ directly. It
+contains the necessary configuration to use cmake and S4U together.
+
+Once you forked the project on FramaGit, do not forget to remove the
+fork relationship, as you won't need it unless you plan to contribute
+to the template itself.
+

 Building your project with CMake
 --------------------------------
 
 Building your project with CMake
 --------------------------------
 


@@ -17,7 +29,8 @@ your project. It builds two simulators from a given set of source files.
 
 .. code-block:: cmake
 
 
 .. code-block:: cmake
 

-   project(MyFirstScheduler)
+   cmake_minimum_required(VERSION 2.8.8)
+   project(MyFirstSimulator)

    
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
    
    
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
    


@@ -34,7 +47,8 @@ your project. It builds two simulators from a given set of source files.
    target_link_libraries(other_xp ${SimGrid_LIBRARY})
 
 
    target_link_libraries(other_xp ${SimGrid_LIBRARY})
 
 

-For that, you need <a href="https://github.com/simgrid/simgrid/blob/master/FindSimGrid.cmake">FindSimGrid.cmake</a>,
+For that, you need `FindSimGrid.cmake
+<https://framagit.org/simgrid/simgrid/raw/master/FindSimGrid.cmake>`_,

 that is located at the root of the SimGrid tree. You can either copy
 this file into the `cmake/Modules` directory of your project, or use
 the version installed on the disk. Both solutions present advantages
 that is located at the root of the SimGrid tree. You can either copy
 this file into the `cmake/Modules` directory of your project, or use
 the version installed on the disk. Both solutions present advantages


@@ -124,7 +138,9 @@ modify the examples directly but instead create your own project in
 eclipse. This will make it easier to upgrade to another version of
 SimGrid.
 
 eclipse. This will make it easier to upgrade to another version of
 SimGrid.
 

-Troubleshooting your project setup
+.. _install_yours_troubleshooting:
+
+Troubleshooting your Project Setup

 ----------------------------------
 
 Library not found
 ----------------------------------
 
 Library not found