]> Creatis software - creaToolsTools.git/blobdiff - Linux/README.txt
#2493 creaToolsTools Feature New Normal - Prepare and Install binary CreaTools...
[creaToolsTools.git] / Linux / README.txt
index b922b611732b6990b0ea020477bb74ec1dd4b0b0..0c65b2f72107124ee9be3f10fcf9c0675a1ae984 100644 (file)
 
 
 
-########################################################################
+#######################################
 To install the CreaTools under Linux, use installscript.
+menu.sh is deprecated. This script should not be used. (It will disappear in a near future.)
+
+
+===================================
+Documentation for installscript
+===================================
 
 Launch 'installscript' in command line to see the list of options.
 
+===== How to Install =======
+0) Not forget:
+   A. Install your ssh key: https://www.creatis.insa-lyon.fr/mywiki/SSH
+       Note: -Put your key in .ssh directory.
+             -Change de right of your 
+                  chmod ugo-rwx  id_dsa 
+                  chmod u+rwx id_dsa 
+   B. Send an email to the web master Fabrice Bellet <fabrice.bellet@creatis.insa-lyon.fr> 
+      to be include in the DataBase-GIT of Creatools.
+
+
+1)
+./installscript all
+
+.....That's all  :-).....
+
+
+
+
+======= Update creatools   =======
+./installscript creatools
+
+
+
+
+
+
+==========================================
+==========================================
+==========================================
+
+
+Exemples of differents configurations :
+
+1)
+./installscript config
+You can check the configuration in scripts/CreaTools-configure.sh
+
+2)
+./installscript 3rd
+
+3)
+./installscript creatools
+
+
+
+
+
+==========================================
+==========================================
+==========================================
+
+
+Exemples of differents configurations :
+
+
+===== How to Install - HTML VERSION =======
+1)
+./installscript -os Fedora -ncore 8 -gdir  $HOME/Creatis/creaTools -instprefix  $HOME/Creatis/creaTools/creatools_install -instprefix3  $HOME/Creatis/creaTools/thirdparty_install -html -build Release config
+
+2) As root
+./installscript 3rd
+
+3) 
+./installscript creatools
+
+
+===== How to Install - GIT VERSION =======
+0) Not forget:
+   A. Install your ssh key: https://www.creatis.insa-lyon.fr/mywiki/SSH
+       Note: -Put your key in .ssh directory.
+             -Change de right of your 
+                  chmod ugo-rwx  id_dsa 
+                  chmod u+rwx id_dsa 
+   B. Send an email to the web master Fabrice Bellet <fabrice.bellet@creatis.insa-lyon.fr> 
+      to be include in the DataBase-GIT of Creatools.
+
+                          
+1)
+./installscript -os Fedora -ncore 8 -gdir  $HOME/Creatis/creaTools -instprefix  $HOME/Creatis/creaTools/creatools_install -instprefix3  $HOME/Creatis/creaTools/thirdparty_install -git -build Release config
+
+2) As root
+./installscript 3rd
+
+3) 
+./installscript creatools
+
+
+
+
+
+
+====================================
+
 -- Some examples:
 
+
+====
+
 # to configure only
-./installscript -gdir $HOME/work/creatools/creainstall config
+./installscript -gdir $HOME/Creatis/All/creainstall config
 or
-./installscript -git sdika -ncore 4 -gdir $HOME/work/creatools/creainstall config
+./installscript -git -ncore 4 -gdir $HOME/Creatis/All/creainstall config
+
 
 # to configure / compile-install all packages and the creatools themselves 
-./installscript -git sdika -ncore 4 -gdir $HOME/work/creatools/creainstall all
+./installscript -git -ncore 4 -gdir $HOME/work/creatools/creainstall all
 
 # compile-install only one part (vtk  for example) ONCE CONFIG HAS BEEN RUN 
 ./installscript 3rd-vtk
 
 
 -- If you choose Git: 
-You must have shared your public key on CREATIS server.
+You must have shared your public key on Git CREATIS server.
+To do so, send your public SSH key to Fabrice Bellet specifying the Git repository name. You need to do it for the Git server, even if you already did it for the CVS or SVN server. 
+
+
+
+===================================
+Documentation for menu.sh
+===================================
+WARNING :
+Use always bash (never use sh!)
+
+A) bash menu.sh
+
+You will be prompted to say what you want to do :
+
+ Configure :........................0 
+ Install Third Party Libraries :....1 (as root)
+ Get and Install the 'CreaTools':...2
+ or
+ Get the 'CreaTools' source files :.2.1 (GIT : as user!)
+ Compile   the CreaTools :..........2.2
+ Install   the CreaTools :..........2.3
+ Use compact menu :.................5
+ or
+ Use expanded menu :................5
+ Uninstall the CreaTools :..........6 
+ Help ..............................7 Help about this menu
+
+ Show some Environment Variables ...8
+ Exit :.............................9
+
+
+B) As a user, choose 'Configure' (0)
+
+You will be prompted to give your preferences :
+
+"Operating System : Fedora/Ubuntu/MacOS"
+"Number of Cores"
+"Name of the Generation Directory"
+"Boolean for Doc Generation : YES/NO"
+"Where do you want to get source files from : GIT/HTML"
+
+-> if you chose GIT: 
+1/ you must have shared your public key on CREATIS server
+
+"GIT User name"
+"Login 'User' name"
+"Login 'Group' name"
+"Build type : Release/Debug"
+"Gdcm version : GDCM1/GDCM2"
+"ITK version : ITK3/ITK4"
+
+Note : Currently, only GDCM1 and ITK 3 are supported.
+
+C)  - Exit the menu (9).
+    - Switch as root and run 'bash menu.sh'.
+    - Choose 'Install Third Party Libraries' (1).
+    - Close the terminal window.
+
+D) - Open a new terminal window.
+   - Switch as a user.
+   - Launch 'bash menu.sh'. 
+   - Choose 'Get and Install the CreaTools source files' (2).
+   - Close the terminal window.
+
+E) Open a new terminal window.
+   You can work, by launching creaTools.sh!