nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Complete the INSTALL file. Minimal install is the default behavior

Browse source 
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@2721 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
quemy 2012-08-22 09:43:34 +00:00
commit f90ff04e2c
2 changed files with 39 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

44
trunk/INSTALL
View file

@ -53,12 +53,14 @@ After getting ParadisEO sources from repository, you have to create a build dire
To make the installation easier, ParadisEO propose you two installation types which are "Full" and "Min".
Full corresponds examples / lessons, tests and obviously libraries.
Min corresponds to libraries and headers.
Min corresponds to libraries and headers and it's the standard behavior.
You can specified an installation type by adding the following declaration to cmake :
> cmake .. -DINSTALL_TYPE=full
> cmake .. -DINSTALL_TYPE=min
which is equivalent to
> cmake ..
Actually, by default the generator will be "Unix Makefiles" and cmake will try to look for a C++ compiler.
Be sure you have make installed, or choose an alternative according to your configuration.
@ -84,7 +86,37 @@ To install ParadisEO in standard paths (such as /usr/lib for lib and /usr/includ
> make install
------------------------------------------------------------------------------------------
2. DOCUMENTATION
2. SPECIFIC MODULE
------------------------------------------------------------------------------------------
2.1 EO MODULE ONLY
------------------------------------------------------------------------------------------
If you want to compile and install only the Evolving Objects module, you can add to CMake the following option :
> cmake .. -DEO_ONLY
------------------------------------------------------------------------------------------
2.1 SMP MODULE
------------------------------------------------------------------------------------------
WARNING : The SMP module requires gcc 4.7 or higher. This is due to the fact that it uses the new C++ standard.
WARNING : At the moment, the SMP module does not work on Windows or Mac OS X since MinGW does not provide support for std::thread
and Apple does not supply a recent version of gcc (but you can try to compile gcc 4.7 by yourself).
To enable the compilation of the SMP module, just add -DSMP=true to CMake :
> cmake .. -DSMP=true
Depending on your distribution, you might have to give to CMake the path of gcc and g++ 4.7.
This is the case for Ubuntu 12.04 LTS for instance. Please, check installation guide on ParadisEO website for more details.
If you are in that case and assuming you have a standard path for gcc et g++ 4.7 :
> cmake .. -DSMP=true -DCMAKE_C_COMPILER=/usr/bin/gcc-4.7 -DCMAKE_CXX_COMPILER=/usr/bin/g++-4.7
------------------------------------------------------------------------------------------
3. DOCUMENTATION
------------------------------------------------------------------------------------------
There is 2 ways to build ParadisEO documentation : module by module, or all the documentation.
@ -100,7 +132,7 @@ Each documentation are generated separatly in the module build folder.
For instance, after the generation of the MO documentation, you will find it in build/paradise-mo/doc.
------------------------------------------------------------------------------------------
3. LESSONS / EXAMPLES
4. LESSONS / EXAMPLES
------------------------------------------------------------------------------------------
Examples and lessons are generated by default.
@ -112,9 +144,9 @@ For instance, make moLesson4 will build the Lesson 4 from the MO module.
Easy, isn't it ?
------------------------------------------------------------------------------------------
4. TESTS
5. TESTS
------------------------------------------------------------------------------------------
4.1 CTESTS
5.1 CTESTS
------------------------------------------------------------------------------------------
By performing tests, you can check your installation.
@ -124,7 +156,7 @@ To enable testing, define -DENABLE_TESTING when you launch cmake.
To perform tests simply type ctest ou make test.
------------------------------------------------------------------------------------------
4.2 REPORTING
5.2 REPORTING
------------------------------------------------------------------------------------------
Feel free to send us reports about building, installation, tests and profiling in order to help us to improve compatibilty and installation process. Sending reports is very simple :

2
trunk/cmake/Config.cmake
View file

@ -53,7 +53,7 @@ endif(SMP)
if(INSTALL_TYPE STREQUAL full)
set(ENABLE_CMAKE_EXAMPLE "true" CACHE PATH "ParadisEO examples")
set(ENABLE_CMAKE_TESTING "true" CACHE PATH "ParadisEO tests")
elseif(INSTALL_TYPE STREQUAL min)
elseif(INSTALL_TYPE STREQUAL min OR "INSTALL_TYPE" STREQUAL "")
set(ENABLE_CMAKE_EXAMPLE "false" CACHE PATH "ParadisEO examples")
set(ENABLE_CMAKE_TESTING "false" CACHE PATH "ParadisEO tests")
endif()