From: Martin Quinson Date: Wed, 14 Mar 2018 07:05:55 +0000 (+0100) Subject: doc: improve advices dealing with FindSimGrid X-Git-Tag: v3.19~51 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/1383a91c6154886c9c151f607cb5a2085fbb7d8d doc: improve advices dealing with FindSimGrid --- diff --git a/doc/doxygen/install_yours.doc b/doc/doxygen/install_yours.doc index 09bacffbe8..1046f524c2 100644 --- a/doc/doxygen/install_yours.doc +++ b/doc/doxygen/install_yours.doc @@ -22,9 +22,6 @@ documentation. Here is a `CMakeLists.txt` that you can use as a starting point for your project. It builds two simulators from a given set of source files. -You first need to copy the `FindSimGrid.cmake` (at the root of the -SimGrid tree) into the `cmake/Modules` directory of your project. - @verbatim project(MyFirstScheduler) @@ -43,6 +40,15 @@ add_executable(other_xp ${OTHER_SOURCES}) target_link_libraries(other_xp ${SimGrid_LIBRARY}) @endverbatim +For that, you need 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 +and drawback: if you copy the file, you have to keep it in sync +manually but your project will produce relevant error messages when +trying to compile on a machine where SimGrid is not installed. Please +also refer to the file header for more information. + @section install_yours_makefile Building your project with Makefile Here is a Makefile that will work if your project is composed of three