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
  38 ===== How to Install (HTML VERSION)=======
  39 1)
  40 ./installscript -os Fedora -ncore 8 -gdir  $HOME/Creatis/creaTools -instprefix  $HOME/Creatis/creaTools/creatools_install -instprefix3  $HOME/Creatis/creaTools/thirdparty_install -build Release config
  41
  42 2) As root
  43 ./installscript 3rd
  44
  45 3)
  46 ./installscript creatools
  47
  48
  49 ===== How to Install (GIT VERSION)=======
  50 0) Not forget:
  51    A. Install your ssh key: https://www.creatis.insa-lyon.fr/mywiki/SSH
  52        Note: -Put your key in .ssh directory.
  53              -Change de right of your
  54                   chmod ugo-rwx  id_dsa
  55                   chmod u+rwx id_dsa
  56    B. Send an email to the web master Fabrice Bellet <fabrice.bellet@creatis.insa-lyon.fr>
  57       to be include in the DataBase-GIT of Creatools.
  58
  59
  60 1)
  61 ./installscript -os Fedora -ncore 8 -gdir  $HOME/Creatis/creaTools -instprefix  $HOME/Creatis/creaTools/creatools_install -instprefix3  $HOME/Creatis/creaTools/thirdparty_install -git -build Release config
  62
  63 2) As root
  64 ./installscript 3rd
  65
  66 3)
  67 ./installscript creatools
  68
  69
  70
  71
  72
  73
  74 ====================================
  75
  76 -- Some examples:
  77
  78
  79 ====
  80
  81 # to configure only
  82 ./installscript -gdir $HOME/Creatis/All/creainstall config
  83 or
  84 ./installscript -git -ncore 4 -gdir $HOME/Creatis/All/creainstall config
  85
  86
  87 # to configure / compile-install all packages and the creatools themselves
  88 ./installscript -git -ncore 4 -gdir $HOME/work/creatools/creainstall all
  89
  90 # compile-install only one part (vtk  for example) ONCE CONFIG HAS BEEN RUN
  91 ./installscript 3rd-vtk
  92
  93
  94 -- If you choose Git:
  95 You must have shared your public key on Git CREATIS server.
  96 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.
  97
  98
  99
 100 ===================================
 101 Documentation for menu.sh
 102 ===================================
 103 WARNING :
 104 Use always bash (never use sh!)
 105
 106 A) bash menu.sh
 107
 108 You will be prompted to say what you want to do :
 109
 110  Configure :........................0
 111  Install Third Party Libraries :....1 (as root)
 112  Get and Install the 'CreaTools':...2
 113  or
 114  Get the 'CreaTools' source files :.2.1 (GIT : as user!)
 115  Compile   the CreaTools :..........2.2
 116  Install   the CreaTools :..........2.3
 117
 118  Use compact menu :.................5
 119  or
 120  Use expanded menu :................5
 121  Uninstall the CreaTools :..........6
 122  Help ..............................7 Help about this menu
 123
 124  Show some Environment Variables ...8
 125  Exit :.............................9
 126
 127
 128 B) As a user, choose 'Configure' (0)
 129
 130 You will be prompted to give your preferences :
 131
 132 "Operating System : Fedora/Ubuntu/MacOS"
 133 "Number of Cores"
 134 "Name of the Generation Directory"
 135 "Boolean for Doc Generation : YES/NO"
 136 "Where do you want to get source files from : GIT/HTML"
 137
 138 -> if you chose GIT:
 139 1/ you must have shared your public key on CREATIS server
 140
 141 "GIT User name"
 142 "Login 'User' name"
 143 "Login 'Group' name"
 144 "Build type : Release/Debug"
 145 "Gdcm version : GDCM1/GDCM2"
 146 "ITK version : ITK3/ITK4"
 147
 148 Note : Currently, only GDCM1 and ITK 3 are supported.
 149
 150 C)  - Exit the menu (9).
 151     - Switch as root and run 'bash menu.sh'.
 152     - Choose 'Install Third Party Libraries' (1).
 153     - Close the terminal window.
 154
 155 D) - Open a new terminal window.
 156    - Switch as a user.
 157    - Launch 'bash menu.sh'.
 158    - Choose 'Get and Install the CreaTools source files' (2).
 159    - Close the terminal window.
 160
 161 E) Open a new terminal window.
 162    You can work, by launching creaTools.sh!