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 two solution to install the creatools under Linux:
  28 -- the new install script (called installscript)
  29 -- the old interactive script (menu.sh) (obsolete will disappear in a near future)
  30
  31
  32 ===================================
  33 doc for installscript
  34 ===================================
  35
  36 -- some example:
  37
  38 # to configure only
  39 ./installscript -gdir $HOME/work/creatools/creainstall config
  40 or
  41 ./installscript -cvs sdika -ncore 4 -gdir $HOME/work/creatools/creainstall config
  42
  43 # to configure / compile-install all packages and the creatools themselves
  44 ./installscript -cvs sdika -ncore 4 -gdir $HOME/work/creatools/creainstall all
  45
  46 # compile-install only one part (vtk  for example) ONCE CONFIG HAS BEEN RUN
  47 ./installscript 3rd-vtk
  48
  49
  50
  51
  52 ===================================
  53 doc for menu.sh
  54 ===================================
  55 WARNING :
  56 Use always bash (never use sh!)
  57
  58 A) bash menu.sh
  59
  60 You will be prompted to say what you want to do :
  61
  62  Configure :........................0
  63  Install Third Party Libraries :....1 (as root)
  64  Get and Install the 'CreaTools':...2
  65  or
  66  Get the 'CreaTools' source files :.2.1 (CVS : as user!)
  67  Compile   the CreaTools :..........2.2
  68  Install   the CreaTools :..........2.3
  69
  70  Use compact menu :.................5
  71  or
  72  Use expanded menu :................5
  73  Uninstall the CreaTools :..........6
  74  Help ..............................7 Help about this menu
  75
  76  Show some Environment Variables ...8
  77  Exit :.............................9
  78
  79
  80 B) As a user, choose 'Configure' (0)
  81
  82 You will be prompted to give your preferences :
  83
  84 "Operating System : Fedora/Ubuntu/MacOS"
  85 "Number of Cores"
  86 "Name of the Generation Directory"
  87 "Boolean for Doc Generation : YES/NO"
  88 "Where do you want to get source files from : CVS/HTML"
  89
  90 -> if you chose CVS:
  91 1/ you must have shared your public key on CREATIS server
  92 2/ you have to set properly the CVSROOT environment variable
  93 (see https://www.creatis.insa-lyon.fr/mywiki/Utiliser_CVS_avec_la_ligne_de_commande)
  94
  95 "CVS User name"
  96 "Login 'User' name"
  97 "Login 'Group' name"
  98 "Build type : Release/Debug"
  99 "Gdcm version : GDCM1/GDCM2"
 100 "ITK version : ITK3/ITK4"
 101
 102 Note : Currently, only GDCM1 and ITK 3 are supported.
 103
 104 C)  - Exit the menu (9).
 105     - Switch as root and run 'bash menu.sh'.
 106     - Choose 'Install Third Party Libraries' (1).
 107     - Close the terminal window.
 108
 109 D) - Open a new terminal window.
 110    - Switch as a user.
 111    - Launch 'bash menu.sh'.
 112    - Choose 'Get and Install the CreaTools source files' (2).
 113    - Close the terminal window.
 114
 115 E) Open a new terminal window.
 116    You can work, by launching creaTools.sh!