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