]> Creatis software - creaToolsTools.git/blobdiff - Linux/README.txt
#2493 creaToolsTools Feature New Normal - Prepare and Install binary CreaTools...
[creaToolsTools.git] / Linux / README.txt
index cbab0d5779a50aa09dd85a7e208a916ded68ed4b..ae2743fd8425833e8931ad05705023ed70a6c2ab 100644 (file)
+# ---------------------------------------------------------------------
+#
+# Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image 
+#                        pour la Santé)
+# Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
+#
+#  This software is governed by the CeCILL-B license under French law and 
+#  abiding by the rules of distribution of free software. You can  use, 
+#  modify and/ or redistribute the software under the terms of the CeCILL-B 
+#  license as circulated by CEA, CNRS and INRIA at the following URL 
+#  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html 
+#  or in the file LICENSE.txt.
+#
+#  As a counterpart to the access to the source code and  rights to copy,
+#  modify and redistribute granted by the license, users are provided only
+#  with a limited warranty  and the software's author,  the holder of the
+#  economic rights,  and the successive licensors  have only  limited
+#  liability. 
+#
+#  The fact that you are presently reading this means that you have had
+#  knowledge of the CeCILL-B license and that you accept its terms.
+# ------------------------------------------------------------------------  
+
+
 
 #######################################
-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 config
+
+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 -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!)
@@ -39,7 +141,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
  
@@ -61,14 +163,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"