X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=Linux%2FREADME.txt;h=4873a469a6b58c938c555a131079eca6663a2456;hb=92e2861847038124e273a60c80c9a85a821e9a55;hp=c9709e6de21ea4374f935ff76e3f338f001bae79;hpb=c904405cb22ebd6a5bfc91e732846986151a3435;p=creaToolsTools.git

diff --git a/Linux/README.txt b/Linux/README.txt
index c9709e6..4873a46 100644
--- a/Linux/README.txt
+++ b/Linux/README.txt
@@ -1,5 +1,62 @@
+# ---------------------------------------------------------------------
+#
+# 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.
+# ------------------------------------------------------------------------  
+
+
+
+#######################################
+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.
+
+-- Some examples:
+
+# to configure only
+./installscript -gdir $HOME/work/creatools/creainstall config
+or
+./installscript -git sdika -ncore 4 -gdir $HOME/work/creatools/creainstall config
+
+# to configure / compile-install all packages and the creatools themselves 
+./installscript -git 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
+
+
+-- If you choose Git: 
+You must have shared your public key on CREATIS server.
+
+
+===================================
+Documentation for menu.sh
+===================================
 WARNING :
-Ise always bash (never use sh!)
+Use always bash (never use sh!)
 
 A) bash menu.sh
 
@@ -7,44 +64,54 @@ You will be prompted to say what you want to do :
 
  Configure :........................0 
  Install Third Party Libraries :....1 (as root)
- Get the 'CreaTools' source files :.2 (if CVS : as user!)
- Compile   the CreaTools :..........3 (as you like [root/user])
- Install   the CreaTools :..........4 (as root)
- Uninstall the CreaTools :..........5 (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) 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)"
-
-C) If 'Third Party Libraries' are not yet installed,
-    - switch as root (if not already done)
-    - choose 'Install Third Party Libraries' (1)
-
-D) Close the window and open a new one.
-   switch as root again
-   bash menu.sh
-   
-E) Choose 'Get the CreaTools source files' (2)
-   
-F) Choose 'Compile the CreaTools' (3)
-
-G) Choose 'Install the CreaTools' (4)
-
-H) 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 : 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!