README.txt

   1 === === ===  NEW (new way) UNIX / LINUX / MacOS users === === ===
   2
   3 0) cd Linux
   4 1) read the README.txt
   5 2) Action!
   6
   7 === === === WINDOWS users === === ===
   8
   9 0) Make sure everything you'll need is properly installed :
  10 crea_Developers_tools, crea_ThirdParty_dlls, and VisualStudioExpress2008
  11 Have a look at :
  12 http://www.creatis.insa-lyon.fr/site/fr/CreatoolsDownload
  13
  14 Change your CVS user in the file All.bat
  15
  16 Copy all the .bat files into one directoy where the tests are going to be run
  17 execute All.bat
  18
  19 Do not forget to run your ssh key with puttyAgent
  20
  21 All the creatools projects are downloaded from the CVS, compiled and the CTest for the dashboard is run.
  22
  23
  24
  25
  26
  27
  28
  29
  30 Forget the following lines !
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45 === === ===   (new way) UNIX / LINUX users === === ===
  46
  47
  48 1) Make sure everything you'll need is properly installed :
  49 crea_Developers_tools, crea_ThirdParty_Libraries
  50
  51 have a look at :
  52 http://www.creatis.insa-lyon.fr/site/fr/CreatoolsDownload
  53 and/or :
  54 cd Install_ThirdParty
  55 follow the Readme.txt
  56
  57 2) make sure VTK_DIR environment variable is set properly :
  58 echo $VTK_DIR
  59 Set it, if not OK:
  60 export VTK_DIR=/usr/local/lib/vtk-5.4, for instance
  61
  62 3) make sure LATEX_COMPILER environment variable is set properly :
  63 echo $LATEX_COMPILER
  64 Set it, if not OK:
  65 export LATEX_COMPILER=/usr/bin/latex, for instance
  66
  67 4) Make sure you got the last version of creaToolsTools.
  68 cvs update -dP creaToolsTools
  69
  70 a) cd Install
  71
  72 b) cp configure.sh_TEMPLATE  configure.sh
  73
  74 c) modify (only once) the file configure.sh, according to your preferences:
  75 vim configure.sh
  76 as follows :
  77 -- configure.sh ---------------------
  78 generationdir=<name of the Generation Directory>
  79 docgeneration=<Boolean For Doc Generation> : ON / OFF
  80 cvsUserName=<user Name For CVS>
  81 installPrefix=<installPrefix> : /usr/local or $generationdir/creatools_install
  82 buildType=<buildType> : Release / Debug
  83 gdcmVersion=<GDCM Version> : GDCM1 / GDCM2
  84 sourcesFrom=<where do you want to get them from> : CVS / HTML
  85 --------------------------------------
  86
  87
  88 d) if you choosed  'sourcesFrom=CVS' :
  89 ssh-add
  90 <type your cvs password>
  91
  92 e) sh scripts/make.sh
  93
  94 f) make sure everything is OK
  95
  96 g) switch as root
  97
  98 h) sh scripts/make-install.sh
  99
 100
 101
 102
 103
 104
 105 === === ===  (old way) UNIX / LINUX users === === ===
 106
 107 0)  Make sure you are a 'sudoer'.
 108 have a look at :
 109 --sudo configuration--
 110 https://fedoraproject.org/wiki/Configuring_Sudo
 111
 112 1) ssh-add
 113 <type your cvs password>
 114
 115 2) Make sure you got the last version of creaToolsTools.
 116 cvs update -dP creaToolsTools
 117
 118 3) Make sure everything you'll need is properly installed :
 119 crea_Developers_tools, crea_ThirdParty_Libraries
 120 have a look at :
 121 http://www.creatis.insa-lyon.fr/site/fr/CreatoolsDownload
 122 and/or :
 123 cd Install_ThirdParty
 124 follow the Readme.txt
 125
 126 4) make sure VTK_DIR environment variable is set properly :
 127 echo $VTK_DIR
 128 Set it, if not OK:
 129 export VTK_DIR=/usr/local/lib/vtk-5.4, for instance
 130
 131 5) make sure LATEX_COMPILER environment variable is set properly :
 132 echo $LATEX_COMPILER
 133 Set it, if not OK:
 134 export LATEX_COMPILER=/usr/bin/latex, for instance
 135
 136 6)cd Install
 137 cp creatools.sh_TEMPLATE creatools.sh
 138
 139 7) modify the file creatools.sh, according to your preferences, modify (only once) creatools.sh
 140 vim creatools.sh
 141 as follows :
 142 -- creatools.sh ---------------------
 143 creatoolsGeneration=<directory you want to generate in>
 144 installPrefix=<your Install dir> or </usr/local>
 145 cvsUser=<USER>
 146 docGeneration=<OFF|ON> let it to OFF!
 147 buildType=<Release|Debug>
 148 cd scripts
 149 sh All.sh $creatoolsGeneration $docGeneration $cvsUser $installPrefix $buildType
 150 cd ..
 151 -----------------------
 152
 153 7) Run the whole stuff :
 154 sh creatools.sh
 155
 156 8) if you performed a 'local install' (i.e : you *didn't* use installPrefix=/usr/local)
 157 edit your .bash_profile
 158 PATH=$PATH:<fullPathnameOfYourInstallPrefix>/creatools_install/bin
 159 export PATH
 160 LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<fullPathnameOfYourInstallPrefix>/creatools_install/lib
 161 export LD_LIBRARY_PATH
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175 Forget the following lines !
 176
 177 Tools to manage the creaTools suite (build, test, submit to dashboard, package, ...)
 178 ====================================================================================
 179
 180 * ctest:
 181 ctest scripts and instructions to perform automated build/testing and submission to creatis cdash dashboard
 182 * windows:
 183 windows installers of the suite and instructions to package the suite for windows. subdirs:
 184   * creaThirdParty_dlls:
 185     project which creates the creaThirdParty_dlls win installer (using cmake and NSIS)
 186   * CreaTools_win32_installers:
 187     batch installers of the suite
 188