*** empty log message ***

[creaToolsTools.git] / README.txt

diff --git a/README.txt b/README.txt
index 30954fea2abab916775ac5461d3c91e229d7b335..a1b7bd1b13fbf1c44d625bfc73c582f59f15e62e 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,33 +1,81 @@
-ssh-add
+=== === ===  UNIX / LINUX users === === ===
+
+0)  Make sure you are a 'sudoer'.
+have a look at :
+--sudo configuration--
+https://fedoraproject.org/wiki/Configuring_Sudo
+
+1) ssh-add
 <type your cvs password>
 
-cd Install
+2) Make sure you got the last version of creaToolsTools.
+cvs update -dP creaToolsTools
+
+3) Make sure everything you'll need is properly installed :
+crea_Developers_tools, crea_ThirdParty_Libraries
+have a look at :
+http://www.creatis.insa-lyon.fr/site/fr/CreatoolsDownload
+and/or :
+cd Install_ThirdParty
+follow the Readme.txt
+
+4) make sure VTK_DIR environment variable is set properly :
+echo $VTK_DIR
+Set it, if not OK:
+export VTK_DIR=/usr/local/lib/vtk-5.4, for instance
+
+5) make sure LATEX_COMPILER environment variable is set properly :
+echo $LATEX_COMPILER 
+Set it, if not OK:
+export LATEX_COMPILER=/usr/bin/latex, for instance
+
+6)cd Install
 cp creatools.sh_TEMPLATE creatools.sh
 
-modify the file creatools.sh, according to your preferences, modify (only once) creatools.sh
+7) modify the file creatools.sh, according to your preferences, modify (only once) creatools.sh
 vim creatools.sh
 as follows :
 
 -- creatools.sh ---------------------
 creatoolsGeneration=<directory you want to generate in>
 installPrefix=<your Install dir> or </usr/local> 
-vtkDir=<your vtk dir> ex : /usr/lib64/vtk-5.4/ or /usr/lib/vtk-5.4/, ...
 cvsUser=<USER>
 docGeneration=<OFF|ON> let it to OFF!
 buildType=<Release|Debug>
-archi=<32|64>  according to your processor
-#sudo pwd
 cd scripts
-sh All.sh $creatoolsGeneration $docGeneration $cvsUser $vtkDir $installPrefix $buildType $archi
+sh All.sh $creatoolsGeneration $docGeneration $cvsUser $installPrefix $buildType
 cd .. 
 -----------------------
 
+7) Run the whole stuff :
 sh creatools.sh
 
+8) if you performed a 'local install' (i.e : you *didn't* use installPrefix=/usr/local)
+edit your .bash_profile
+PATH=$PATH:<fullPathnameOfYourInstallPrefix>/creatools_install/bin
+export PATH
+LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<fullPathnameOfYourInstallPrefix>/creatools_install/lib
+export LD_LIBRARY_PATH
+
+
+
+=== === === WINDOWS users === === ===
+
+
+
+0) Make sure everything you'll need is properly installed :
+crea_Developers_tools, crea_ThirdParty_dlls, and VisualStudioExpress2008
+Have a look at :
+http://www.creatis.insa-lyon.fr/site/fr/CreatoolsDownload
 
+Change your CVS user in the file All.bat
 
+Copy all the .bat files into one directoy where the tests are going to be run
+execute All.bat
 
+Not forget to run your ssh key with puttyAgent
 
+All the creatools projects are downloaded from the CVS, compiled and the CTest for the dashboard is run.