add readme.md

ae1b4bdf · Sylvain Thery · ccdeee4f · ae1b4bdf · ae1b4bdf · ae1b4bdf
Commit ae1b4bdf authored Jul 15, 2014 by Sylvain Thery
Hide whitespace changes
Inline Side-by-side

Showing with 262 additions and 86 deletions

CMakeLists.txt CMakeLists.txt +3 -2

README.TXT README.TXT +97 -84

README.md README.md +162 -0

No files found.
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -21,7 +21,8 @@ ENDIF()
 # for shared or not shared
 SET ( BUILD_SHARED_LIBS OFF CACHE BOOL "if used all library are build as shared type (.so/.dylib/.dll)" )

-IF(EXISTS "${CGoGN_ROOT_DIR}/ThirdParty/include/Assimp")
+#IF(EXISTS "${CGoGN_ROOT_DIR}/ThirdParty/include/Assimp")
+IF(EXISTS "${CGoGN_ROOT_DIR}/lib/${CMAKE_BUILD_TYPE}/*assimp*")
 	SET ( WITH_ASSIMP ON CACHE BOOL "build CGoGN with Assimp" )
 ELSE()
 	SET ( WITH_ASSIMP OFF CACHE BOOL "build CGoGN with Assimp" )
@@ -60,7 +61,7 @@ find_package(LibXml2 REQUIRED)
 find_package(GLEW REQUIRED)

 # MESSAGE HERE FOR MORE EASY USER READING
-MESSAGE("Building type = " ${CMAKE_BUILD_TYPE} " (for change -DCMAKE_BUILD_TYPE=Release|Debug)" )
+MESSAGE("Building type = " ${CMAKE_BUILD_TYPE} " (for change with cmake use -DCMAKE_BUILD_TYPE=Release|Debug)" )


 IF (DEFINED ASSERTON)

--- a/README.TXT
+++ b/README.TXT
-Dépendences Linux:
-installer les paquets suivants:
-cmake cmake-curses-gui libXi-dev libXmu-dev libglew-dev libxml2-dev libboost-all-dev zlib1g-dev qt4-designer qt4-dev-tools uuid-dev libgsl0-dev libsuitesparse-dev
+English version bellow

-Pour compiler CGoGN:
+Dépendences Linux
+=================
+installer les paquets suivants:  
+cmake cmake-curses-gui cmake-qt-gui libXi-dev libXmu-dev libglew-dev libxml2-dev libboost-all-dev zlib1g-dev qt4-designer qt4-dev-tools uuid-dev libgsl0-dev libsuitesparse-dev

-  - on compile tout d'abord les bibliothèques third-party :

-	cd CGoGN/ThirdParty/build
-	cmake ..
-	make (-j x si vous avez x cores)
-	make install
+Pour compiler CGoGN
+===================

-	La même chose en debug:
-	cd ../buildDebug
-	cmake ..
-	make (-j x si vous avez x cores)
+* on compile tout d'abord les bibliothèques third-party :

-	On peut fixer certaines option pour ne pas tout compiler (cf le README.TXT dans ThirdParty)
+cd CGoGN/ThirdParty/build  
+cmake ..  
+make (-j x si vous avez x cores)  
+make install  
+
+La même chose en debug:  
+cd ../buildDebug  
+cmake ..  
+make (-j x si vous avez x cores)  
+
+On peut fixer certaines option pour ne pas tout compiler:
+	* WITH_ASSIMP  -> compile et utilise la librairie Assimp
+	* WITH_ZINRI -> compile et utilise la librairie Zinri  
+	* WITH_PYTHONQT	-> pour SCHNApps
 	
-  - ensuite on compile CGoGN (compile les libs dans CGoGN/lib et des exemples dans CGoGN/bin) :
+* ensuite on compile CGoGN :  
+	cd CGoGN/build  
+	cmake ..  
+	make (-j x si vous avez x cores)  

-	cd CGoGN/build
-	cmake ..
-	make (-j x si vous avez x cores)
+	Et en Debug avec:  
+	cd ../buildDebug  
+	cmake ..  
+	make (-j x si vous avez x cores)  

-	Et en Debug avec:
-	cd ../buildDebug
-	cmake ..
-	make (-j x si vous avez x cores)
+    Certaines options sont disponibles :

-    -> certaines options sont disponibles :
+	* BUILD_SHARED_LIBS  (F) experimental !  
+	* WITH_ASSIMP        (?)  
+	* WITH_ZINRI ->
+	* WITH_QT	 -> afin de limiter les dépendances et le temps de compilation  
+	* ONELIB	-> permet de forcer la compilation en une seule lib (libcgogn.a) au lieu de quatre.

-	  BUILD_SHARED_LIBS  (F) experimental !
-	  WITH_ASSIMP        (T)
-	  WITH_ZINRI         (T)
-	  WITH_QT	     (T)
-	    -> afin de limiter les dépendances et le temps de compilation
-	
-	  ONELIB             (F)
-	    -> permet de forcer la compilation en une seule lib (libcgogn.a) au lieu de quatre.
+	* BUILD_SHARED_LIBS -Q experimental !
+	* ONELIB	-> compilation en une seule lib (libcgogn.a) au lieu de 4
+	* WITH_ASSIMP  -> utilise Assimp (auto set par third party compil)
+	* WITH_ZINRI -> utilise Zinri (auto set par third party compil)
+	* WITH_QT	-> minimize les dependence si pas besoin de Qt (VRJuggler)
+	* WITH_GLEWMX  -> pour utiliser GLEWMX a la place de GELW (pour VRJuggler)

-  - on peut ensuite compiler SCHNApps ainsi que les plugins fournis :
-	
-	cd CGoGN/SCHNApps/build
-	cmake ..
-	make (-j x si vous avez x cores)

-	Et en Debug avec:
-	cd ../buildDebug
-	cmake ..
-	make (-j x si vous avez x cores)
+	Les librairies sont generees dans lib/Release et lib/Debug  
+	Les binaires sont generes dans bin/Release et bin/Debug


-Les librairies sont generees dans lib/Release et lib/Debug
-Les binaires sont generes dans bin/Release et bin/Debug
+* on peut ensuite compiler SCHNApps ainsi que les plugins fournis :
+	
+	cd CGoGN/SCHNApps/build  
+	cmake ..  
+	make (-j x si vous avez x cores)  
+
+	Et en Debug avec:  
+	cd ../buildDebug  
+	cmake ..  
+	make (-j x si vous avez x cores)  


 Des exemples de données (fichiers trianbgz, off, etc..) sont accessible à l'adresse suivante: 
 https://iggservis.u-strasbg.fr/Data/data.zip


-=========================================================================================
-                                ENGLISH VERSION
-=========================================================================================
-
-Linux dependencies:
-install the following packages:
-cmake cmake-curses-gui libXi-dev libXmu-dev libglew-dev libxml2-dev libboost-all-dev zlib1g-dev qt4-designer qt4-dev-tools uuid-dev libgsl0-dev libsuitesparse-dev
+ENGLISH VERSION
+===============

-To compile CGoGN:
+Linux dependencies
+==================
+install the following packages:  
+cmake cmake-curses-gui cmake-qt-gui libXi-dev libXmu-dev libglew-dev libxml2-dev libboost-all-dev zlib1g-dev qt4-designer qt4-dev-tools uuid-dev libgsl0-dev libsuitesparse-dev

-  - first compile third-party libraries:
+To compile CGoGN
+================
+ * first compile third-party libraries:

-	cd CGoGN/ThirdParty/build
-	cmake ..
-	make (-j x if you have x cores)
-	make install
+	cd CGoGN/ThirdParty/build  
+	cmake ..  
+	make (-j x if you have x cores)  
+	make install  

-	In debug mode
-	cd ../buildDebug
-	cmake ..
-	make 
+	In debug mode:  
+	cd ../buildDebug  
+	cmake ..  
+	make  

-	Some options are available to not compile everything (see the README.TXT in ThirdParty)
+	Some options are available to not compile everything:
+	* WITH_ASSIMP  -> compile and use Assimp library 
+	* WITH_ZINRI -> compile and use Zinri library 
+	* WITH_PYTHONQT	-> needed by SCHNApps

-  - then compile CGoGN (the libs are generated in CGoGN/lib and some examples in CGoGN/bin):
+* then compile CGoGN (the libs are generated in CGoGN/lib and some examples in CGoGN/bin):

-	cd CGoGN/build
-	cmake ..
-	make (-j x if you have x cores)
+	cd CGoGN/build  
+	cmake ..  
+	make (-j x if you have x cores)  

-	in debug mode:
-	cd ../buildDebug
-	cmake ..
-	make
+	in debug mode:  
+	cd ../buildDebug  
+	cmake ..  
+	make  

-	-> some options are available:.
+	Some options are available:

-	  BUILD_SHARED_LIBS  (F) experimental !
-	  WITH_ASSIMP        (T)
-	  WITH_ZINRI         (T)
-	  WITH_QT	     (T)
-	    -> to minimize dependencies and compilation time
-	
-	  ONELIB             (F)
-	    -> allow compilation in one lib (libcgogn.a) instead of four.
+	* BUILD_SHARED_LIBS  (F) experimental !
+	* ONELIB	-> allow compilation in one lib (libcgogn.a) instead of four.
+	* WITH_ASSIMP  -> use Assimp library (auto setted by third party compiling)
+	* WITH_ZINRI -> use Zinri library (auto setted by third party compiling)
+	* WITH_QT	-> to minimize dependencies and compilation time
+	* WITH_GLEWMX  -> to use GLEWMX (for VRJuggler users)

-  - we can then compile SCHNApps and the provided plugins :
+* we can then compile SCHNApps and the provided plugins :
 	
-	cd CGoGN/SCHNApps/build
-	cmake ..
-	make (-j x if you have x cores)
+	cd CGoGN/SCHNApps/build  
+	cmake ..  
+	make (-j x if you have x cores)  

 	in debug mode:
-	cd ../buildDebug
-	cmake ..
-	make 
+	cd ../buildDebug  
+	cmake ..  
+	make  

 Libraries are generated in lib/Release and lib/Debug
 Binaries are generated in bin/Release and bin/Debug

--- a/README.md
+++ b/README.md
+English version bellow
+
+Dpendences Linux
+=================
+installer les paquets suivants:  
+cmake cmake-curses-gui cmake-qt-gui libXi-dev libXmu-dev libglew-dev libxml2-dev libboost-all-dev zlib1g-dev qt4-designer qt4-dev-tools uuid-dev libgsl0-dev libsuitesparse-dev
+
+
+Pour compiler CGoGN
+===================
+
+* on compile tout d'abord les bibliothques third-party :
+
+``` 
+cd CGoGN/ThirdParty/build  
+cmake ..  
+make (-j x si vous avez x cores)  
+make install  
+```
+
+La mme chose en debug:  
+```
+cd ../buildDebug  
+cmake ..  
+make (-j x si vous avez x cores)  
+```
+
+On peut fixer certaines option pour ne pas tout compiler:
+	* WITH_ASSIMP  -> compile et utilise la librairie Assimp
+	* WITH_ZINRI -> compile et utilise la librairie Zinri  
+	* WITH_PYTHONQT	-> pour SCHNApps
+	
+* ensuite on compile CGoGN :  
+	```
+	cd CGoGN/build  
+	cmake ..  
+	make (-j x si vous avez x cores)  
+	```
+
+	Et en Debug avec:  
+	```
+	cd ../buildDebug  
+	cmake ..  
+	make (-j x si vous avez x cores)  
+	```
+
+    Certaines options sont disponibles :
+
+	* BUILD_SHARED_LIBS  (F) experimental !  
+	* WITH_ASSIMP        (?)  
+	* WITH_ZINRI ->
+	* WITH_QT	 -> afin de limiter les dpendances et le temps de compilation  
+	* ONELIB	-> permet de forcer la compilation en une seule lib (libcgogn.a) au lieu de quatre.
+
+	* BUILD_SHARED_LIBS -Q experimental !
+	* ONELIB	-> compilation en une seule lib (libcgogn.a) au lieu de 4
+	* WITH_ASSIMP  -> utilise Assimp (auto set par third party compil)
+	* WITH_ZINRI -> utilise Zinri (auto set par third party compil)
+	* WITH_QT	-> minimize les dependence si pas besoin de Qt (VRJuggler)
+	* WITH_GLEWMX  -> pour utiliser GLEWMX a la place de GELW (pour VRJuggler)
+
+
+	Les librairies sont generees dans lib/Release et lib/Debug  
+	Les binaires sont generes dans bin/Release et bin/Debug
+
+
+* on peut ensuite compiler SCHNApps ainsi que les plugins fournis :
+	
+	```
+	cd CGoGN/SCHNApps/build  
+	cmake ..  
+	make (-j x si vous avez x cores)  
+	```
+
+	Et en Debug avec:  
+	```
+	cd ../buildDebug  
+	cmake ..  
+	make (-j x si vous avez x cores)  
+	```
+
+
+Des exemples de donnes (fichiers trianbgz, off, etc..) sont accessible  l'adresse suivante: 
+https://iggservis.u-strasbg.fr/Data/data.zip
+
+
+ENGLISH VERSION
+===============
+
+Linux dependencies
+==================
+install the following packages:  
+cmake cmake-curses-gui cmake-qt-gui libXi-dev libXmu-dev libglew-dev libxml2-dev libboost-all-dev zlib1g-dev qt4-designer qt4-dev-tools uuid-dev libgsl0-dev libsuitesparse-dev
+
+To compile CGoGN
+================
+ * first compile third-party libraries:
+
+	```
+	cd CGoGN/ThirdParty/build  
+	cmake ..  
+	make (-j x if you have x cores)  
+	make install  
+	```
+
+	In debug mode:  
+	```
+	cd ../buildDebug  
+	cmake ..  
+	make  
+	```
+
+	Some options are available to not compile everything:
+	* WITH_ASSIMP  -> compile and use Assimp library 
+	* WITH_ZINRI -> compile and use Zinri library 
+	* WITH_PYTHONQT	-> needed by SCHNApps
+
+* then compile CGoGN (the libs are generated in CGoGN/lib and some examples in CGoGN/bin):
+
+	```
+	cd CGoGN/build  
+	cmake ..  
+	make (-j x if you have x cores)  
+	```
+
+	in debug mode:  
+	```
+	cd ../buildDebug  
+	cmake ..  
+	make  
+	```
+
+	Some options are available:
+
+	* BUILD_SHARED_LIBS  (F) experimental !
+	* ONELIB	-> allow compilation in one lib (libcgogn.a) instead of four.
+	* WITH_ASSIMP  -> use Assimp library (auto setted by third party compiling)
+	* WITH_ZINRI -> use Zinri library (auto setted by third party compiling)
+	* WITH_QT	-> to minimize dependencies and compilation time
+	* WITH_GLEWMX  -> to use GLEWMX (for VRJuggler users)
+
+* we can then compile SCHNApps and the provided plugins :
+	
+	```
+	cd CGoGN/SCHNApps/build  
+	cmake ..  
+	make (-j x if you have x cores)  
+	```
+
+	in debug mode:
+	```
+	cd ../buildDebug  
+	cmake ..  
+	make  
+	```
+
+Libraries are generated in lib/Release and lib/Debug
+Binaries are generated in bin/Release and bin/Debug
+
+
+Examples of data (trianbgz, off, etc.. files) are available at the following address:
+https://iggservis.u-strasbg.fr/Data/data.zip