]> Creatis software - creaToolsTools.git/blobdiff - Linux/README.txt
Feature #1773 Add licence terms for all files.
[creaToolsTools.git] / Linux / README.txt
index 8332bdcf641c4d4d51635684deb98ecb2126ee72..f26a08e54baf9a1bd2a89a77ad22e24508b83cec 100644 (file)
-1) switch as root
+# ---------------------------------------------------------------------
+#
+# 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.
+# ------------------------------------------------------------------------  
 
-2) sh menu.sh
+
+
+#######################################
+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)
+
+
+===================================
+doc for installscript
+===================================
+
+-- some example:
+
+# to configure only
+./installscript -gdir $HOME/work/creatools/creainstall config
+or
+./installscript -cvs sdika -ncore 4 -gdir $HOME/work/creatools/creainstall config
+
+# to configure / compile-install all packages and the creatools themselves 
+./installscript -cvs sdika -ncore 4 -gdir $HOME/work/creatools/creainstall all
+
+# compile-install only one part (vtk  for example) ONCE CONFIG HAS BEEN RUN 
+./installscript 3rd-vtk
+
+
+
+
+===================================
+doc 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"
-" Compile   the CreaTools :       2"
-" Install   the CreaTools :       3"
-" Uninstall the CreaTools :       4"
+ Configure :........................0 
+ Install Third Party Libraries :....1 (as root)
+ Get and Install the 'CreaTools':...2
+ or
+ Get the 'CreaTools' source files :.2.1 (CVS : 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
 
-3) Choose 'Configure' (0)
+
+B) As a user, choose 'Configure' (0)
 
 You will be prompted to give your preferences :
 
-"Operating System : Fedora/Ubuntu/MacOS (mandatory!)"
-"Name of the Generation Directory (default is /tmp/myGenerationDir)"
-"Boolean for Doc Generation : YES/NO (default is NO)"
-"Where do you want to get source files from : CVS/HTML (default is HTML)"
--> if you choosed CVS 
-"CVS User name (mandatory!)"
-"Login 'User' name (mandatory!)"
-"Login 'Group' name (mandatory!)"
-"Build type : Release/Debug (default is Release)"
-"Gdcm version : GDCM1/GDCM2 (default is GDCM1)"
-
-4) If 'Third Party Libraries' are not yet installed,
-choose 'Install Third Party Libraries' (1)
-
-5) Close the window and open a new one.
-   switch as root again
-   sh menu.sh
-   
-6) Choose 'Compile the CreaTools' (2)
-
-7) Choose 'Install the CreaTools' (3)
-
-8) Close the window and open a new one.
-   You can work, now.
+"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 : CVS/HTML"
+
+-> if you chose CVS: 
+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"
+"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!