Added documentation to instalscript.

[creaToolsTools.git] / ctest / dashboard / Readme.txt

diff --git a/ctest/dashboard/Readme.txt b/ctest/dashboard/Readme.txt
index 9c44a1c172c36efdaedcd24bc106ba249644ecb5..0dd4b6f6767562fceb5f294d59e65a23b0a26458 100644 (file)
--- a/ctest/dashboard/Readme.txt
+++ b/ctest/dashboard/Readme.txt
@@ -1,6 +1,42 @@
+# ---------------------------------------------------------------------
+#
+# Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image 
+#                        pour la Santé)
+# Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
+#
+#  This software is governed by the CeCILL-B license under French law and 
+#  abiding by the rules of distribution of free software. You can  use, 
+#  modify and/ or redistribute the software under the terms of the CeCILL-B 
+#  license as circulated by CEA, CNRS and INRIA at the following URL 
+#  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html 
+#  or in the file LICENSE.txt.
+#
+#  As a counterpart to the access to the source code and  rights to copy,
+#  modify and redistribute granted by the license, users are provided only
+#  with a limited warranty  and the software's author,  the holder of the
+#  economic rights,  and the successive licensors  have only  limited
+#  liability. 
+#
+#  The fact that you are presently reading this means that you have had
+#  knowledge of the CeCILL-B license and that you accept its terms.
+# ------------------------------------------------------------------------  
+
 Automatic compilation for all the Creatools
 
-Change your CVS user in the file cvschekcout.bat 
+--> WINDOWS USERS :
+Change your CVS user in the file All.bat
+ 
+--> LINUX USERS :
+Change your CVS user in the file cvscheckout.sh
+Change the entry 'VTK_DIR:PATH=' of cmakemod.sh, acording to your own computer
+Use ssh-add and give your pass-phrase (for cvs checkout)
+Run the script as :
+sh All.sh <nameOfTheGenerationDirectory> <BooleanForDocGeneration> <userNameForCVS> <VTKdir>  <installPrefix>
+  ex : sh All.sh /tmp/gendir OFF jpr /usr/local/lib/vtk-5.4   /home/jpr/myInsallDirectory
+ 
+sh All.sh name_of_the_directory_to_generate ON
+(ON : to generate documentation)
+
 
 Requirements
 
@@ -10,17 +46,26 @@ from http://www.creatis.insa-lyon.fr/site/fr/CreatoolsDownload
 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 putyAgent
+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.
 
 
 
 
-===================
-
 =============Install cmake =========================
-1) Install cmake outside the directory "Programs Files"
+
+Install 
+       visualStudio
+       Putty
+       Graphviz
+       doxygen
+       TortoiseCVS
+       NSIS
+        cmake (outside of "Programs Files")
+       crea_ThirdParty_Libraries  (outside of "Programs Files")
+
+outside of "Programs Files"
 To avoid the probleme of: Read only