Linux/README.txt

   1 # ---------------------------------------------------------------------
   2 #
   3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   4 #                        pour la Santé)
   5 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   6 #
   7 #  This software is governed by the CeCILL-B license under French law and
   8 #  abiding by the rules of distribution of free software. You can  use,
   9 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  10 #  license as circulated by CEA, CNRS and INRIA at the following URL
  11 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  12 #  or in the file LICENSE.txt.
  13 #
  14 #  As a counterpart to the access to the source code and  rights to copy,
  15 #  modify and redistribute granted by the license, users are provided only
  16 #  with a limited warranty  and the software's author,  the holder of the
  17 #  economic rights,  and the successive licensors  have only  limited
  18 #  liability.
  19 #
  20 #  The fact that you are presently reading this means that you have had
  21 #  knowledge of the CeCILL-B license and that you accept its terms.
  22 # ------------------------------------------------------------------------
  23
  24
  25
  26 #######################################
  27 To install the CreaTools under Linux, use installscript.
  28 menu.sh is deprecated. This script should not be used. (It will disappear in a near future.)
  29
  30
  31 ===================================
  32 Documentation for installscript
  33 ===================================
  34
  35 Launch 'installscript' in command line to see the list of options.
  36
  37 -- Some examples:
  38
  39 # to configure only
  40 ./installscript -gdir $HOME/work/creatools/creainstall config
  41 or
  42 ./installscript -git sdika -ncore 4 -gdir $HOME/work/creatools/creainstall config
  43
  44 # to configure / compile-install all packages and the creatools themselves
  45 ./installscript -git sdika -ncore 4 -gdir $HOME/work/creatools/creainstall all
  46
  47 # compile-install only one part (vtk  for example) ONCE CONFIG HAS BEEN RUN
  48 ./installscript 3rd-vtk
  49
  50
  51 -- If you choose Git:
  52 You must have shared your public key on CREATIS server.
  53
  54
  55 ===================================
  56 Documentation for menu.sh
  57 ===================================
  58 WARNING :
  59 Use always bash (never use sh!)
  60
  61 A) bash menu.sh
  62
  63 You will be prompted to say what you want to do :
  64
  65  Configure :........................0
  66  Install Third Party Libraries :....1 (as root)
  67  Get and Install the 'CreaTools':...2
  68  or
  69  Get the 'CreaTools' source files :.2.1 (GIT : as user!)
  70  Compile   the CreaTools :..........2.2
  71  Install   the CreaTools :..........2.3
  72
  73  Use compact menu :.................5
  74  or
  75  Use expanded menu :................5
  76  Uninstall the CreaTools :..........6
  77  Help ..............................7 Help about this menu
  78
  79  Show some Environment Variables ...8
  80  Exit :.............................9
  81
  82
  83 B) As a user, choose 'Configure' (0)
  84
  85 You will be prompted to give your preferences :
  86
  87 "Operating System : Fedora/Ubuntu/MacOS"
  88 "Number of Cores"
  89 "Name of the Generation Directory"
  90 "Boolean for Doc Generation : YES/NO"
  91 "Where do you want to get source files from : GIT/HTML"
  92
  93 -> if you chose GIT:
  94 1/ you must have shared your public key on CREATIS server
  95
  96 "GIT User name"
  97 "Login 'User' name"
  98 "Login 'Group' name"
  99 "Build type : Release/Debug"
 100 "Gdcm version : GDCM1/GDCM2"
 101 "ITK version : ITK3/ITK4"
 102
 103 Note : Currently, only GDCM1 and ITK 3 are supported.
 104
 105 C)  - Exit the menu (9).
 106     - Switch as root and run 'bash menu.sh'.
 107     - Choose 'Install Third Party Libraries' (1).
 108     - Close the terminal window.
 109
 110 D) - Open a new terminal window.
 111    - Switch as a user.
 112    - Launch 'bash menu.sh'.
 113    - Choose 'Get and Install the CreaTools source files' (2).
 114    - Close the terminal window.
 115
 116 E) Open a new terminal window.
 117    You can work, by launching creaTools.sh!