Revert "Feature #1929 Removed menu.sh."

[creaToolsTools.git] / Linux / README.txt

diff --git a/Linux/README.txt b/Linux/README.txt
index 73ec67ce6ecb9833455ae77f2d4532148cee374c..0106b052dcf76d873419fa2d2394e3ae8f01f095 100644 (file)
--- a/Linux/README.txt
+++ b/Linux/README.txt
@@ -23,8 +23,14 @@
 
 
 
-########################################################################
+#######################################
 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.
 
@@ -45,3 +51,69 @@ or
 -- 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. 
+
+
+
+===================================
+Documentation 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 (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) As a user, choose 'Configure' (0)
+
+You will be prompted to give your preferences :
+
+"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!