#2493 creaToolsTools Feature New Normal - Prepare and Install binary CreaTools...

[creaToolsTools.git] / Linux / README.txt

diff --git a/Linux/README.txt b/Linux/README.txt
index f26a08e54baf9a1bd2a89a77ad22e24508b83cec..0c65b2f72107124ee9be3f10fcf9c0675a1ae984 100644 (file)
--- a/Linux/README.txt
+++ b/Linux/README.txt
@@ -24,33 +24,136 @@
 
 
 #######################################
-two solution to install the creatools under Linux:
--- the new install script (called installscript) 
--- the old interactive script (menu.sh) (obsolete will disappear in a near future)
+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.)
 
 
 ===================================
-doc for installscript
+Documentation for installscript
 ===================================
 
--- some example:
+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 -cvs 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 -cvs 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 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. 
+
 
 
 ===================================
-doc for menu.sh
+Documentation for menu.sh
 ===================================
 WARNING :
 Use always bash (never use sh!)
@@ -63,7 +166,7 @@ You will be prompted to say what you want to do :
  Install Third Party Libraries :....1 (as root)
  Get and Install the 'CreaTools':...2
  or
- Get the 'CreaTools' source files :.2.1 (CVS : as user!)
+ Get the 'CreaTools' source files :.2.1 (GIT : as user!)
  Compile   the CreaTools :..........2.2
  Install   the CreaTools :..........2.3
  
@@ -85,14 +188,12 @@ You will be prompted to give your preferences :
 "Number of Cores"
 "Name of the Generation Directory"
 "Boolean for Doc Generation : YES/NO"
-"Where do you want to get source files from : CVS/HTML"
+"Where do you want to get source files from : GIT/HTML"
 
--> if you chose CVS: 
+-> if you chose GIT: 
 1/ you must have shared your public key on CREATIS server
-2/ you have to set properly the CVSROOT environment variable
-(see https://www.creatis.insa-lyon.fr/mywiki/Utiliser_CVS_avec_la_ligne_de_commande)
 
-"CVS User name"
+"GIT User name"
 "Login 'User' name"
 "Login 'Group' name"
 "Build type : Release/Debug"