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 -ncore 4 -gdir $HOME/work/creatools/creainstall config
  43
  44 # to configure / compile-install all packages and the creatools themselves
  45 ./installscript -git -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 Git CREATIS server.
  53 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.
  54
  55
  56
  57 ===================================
  58 Documentation for menu.sh
  59 ===================================
  60 WARNING :
  61 Use always bash (never use sh!)
  62
  63 A) bash menu.sh
  64
  65 You will be prompted to say what you want to do :
  66
  67  Configure :........................0
  68  Install Third Party Libraries :....1 (as root)
  69  Get and Install the 'CreaTools':...2
  70  or
  71  Get the 'CreaTools' source files :.2.1 (GIT : as user!)
  72  Compile   the CreaTools :..........2.2
  73  Install   the CreaTools :..........2.3
  74
  75  Use compact menu :.................5
  76  or
  77  Use expanded menu :................5
  78  Uninstall the CreaTools :..........6
  79  Help ..............................7 Help about this menu
  80
  81  Show some Environment Variables ...8
  82  Exit :.............................9
  83
  84
  85 B) As a user, choose 'Configure' (0)
  86
  87 You will be prompted to give your preferences :
  88
  89 "Operating System : Fedora/Ubuntu/MacOS"
  90 "Number of Cores"
  91 "Name of the Generation Directory"
  92 "Boolean for Doc Generation : YES/NO"
  93 "Where do you want to get source files from : GIT/HTML"
  94
  95 -> if you chose GIT:
  96 1/ you must have shared your public key on CREATIS server
  97
  98 "GIT User name"
  99 "Login 'User' name"
 100 "Login 'Group' name"
 101 "Build type : Release/Debug"
 102 "Gdcm version : GDCM1/GDCM2"
 103 "ITK version : ITK3/ITK4"
 104
 105 Note : Currently, only GDCM1 and ITK 3 are supported.
 106
 107 C)  - Exit the menu (9).
 108     - Switch as root and run 'bash menu.sh'.
 109     - Choose 'Install Third Party Libraries' (1).
 110     - Close the terminal window.
 111
 112 D) - Open a new terminal window.
 113    - Switch as a user.
 114    - Launch 'bash menu.sh'.
 115    - Choose 'Get and Install the CreaTools source files' (2).
 116    - Close the terminal window.
 117
 118 E) Open a new terminal window.
 119    You can work, by launching creaTools.sh!