Updated the README.txt file for Linux.

[creaToolsTools.git] / Linux / README.txt

diff --git a/Linux/README.txt b/Linux/README.txt
index 8332bdcf641c4d4d51635684deb98ecb2126ee72..a799a14faa43f9435f0391e235f12ac557775889 100644 (file)
--- a/Linux/README.txt
+++ b/Linux/README.txt
@@ -1,40 +1,60 @@
-1) switch as root
 
-2) sh 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
 
-3) Choose 'Configure' (0)
+ Show some Environment Variables ...8
+ Exit :.............................9
 
-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)
+B) As a user, choose 'Configure' (0)
 
-7) Choose 'Install the CreaTools' (3)
+You will be prompted to give your preferences :
 
-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"
+
+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).
+   
+E) Close the terminal window and open a new one.
+   You can work, by launching creaTools.sh!