]> Creatis software - bbtk.git/blobdiff - kernel/doc/bbtkWebSite/install.html
#3191 BBTK Feature New Normal - HtmlWindow Box
[bbtk.git] / kernel / doc / bbtkWebSite / install.html
index de379974dfa0fd506d4712a9cefe9c749deea5c8..cfc8ce4abd05c5511e837c938ec91d61e535c818 100644 (file)
@@ -1,16 +1,40 @@
+<!--
+# ---------------------------------------------------------------------
+#
+# Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
+#                        pour la SantÈ)
+# Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
+# Previous Authors : Laurent Guigues, Jean-Pierre Roux
+# CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
+#
+#  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.
+# ------------------------------------------------------------------------ */
+-->
+
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 <html>
 <head>
   <meta content="text/html; charset=ISO-8859-1"
  http-equiv="content-type">
-  <title>Install</title>
+  <title>BBTK @BBTK_VERSION@ Install</title>
 </head>
 <body>
-<div style="text-align: center; font-weight: bold;"><big><big><big><small></small></big></big></big>
-<div style="text-align: left;">
-<div style="text-align: center;"><big><big style="font-weight: normal;"><big><big>BBTK
-build instructions
-</big></big></big></big><br>
+<div style="text-align: center;"><big>BBTK @BBTK_VERSION@
+(@BBTK_VERSION_DATE@) build instructions</big><br>
 <div style="text-align: left;">
 <ol id="mozToc">
 <!--mozToc h1 1 h2 2 h3 3 h4 4 h5 5 h6 6-->
@@ -38,19 +62,28 @@ build instructions
  style="font-weight: normal;">Requirements</span></small></small></big></big></big></h2>
 <ul>
   <li><span style="font-weight: normal;">cmake &gt;= 2.4.6</span></li>
+  <li>crea &gt;= 0.2.0<br>
+    <span style="font-weight: normal;"></span></li>
   <li><span style="font-weight: normal;">wxWidgets&nbsp; &gt;= &nbsp;
 2.6.3</span><span style="font-weight: normal;">&nbsp;</span></li>
   <li><span style="font-weight: normal;">optional : <br>
     </span></li>
   <ul>
     <li><span style="font-weight: normal;">L<sub>a</sub>T<sub>e</sub>X
-to generate the pdf doc</span><br>
+to generate the pdf guides</span><br>
       <span style="font-weight: normal;"></span></li>
-    <li><span style="font-weight: normal;">tth to generate the html doc</span></li>
+    <li><span style="font-weight: normal;">tth to generate the html
+guides<br>
+      </span></li>
     <li><span style="font-weight: normal;">itk to compile packages itk,
 itkvtk</span></li>
     <li><span style="font-weight: normal;">vtk to compile package vtk,
 wxvtk</span></li>
+    <li><span style="font-weight: normal;">doxygen to build the sources
+documentation</span></li>
+    <li><span style="font-weight: normal;">graphviz/dot to generate the
+packages doc with pipeline graphs<br>
+      </span></li>
     <ul>
     </ul>
   </ul>
@@ -60,6 +93,7 @@ wxvtk</span></li>
  style="font-weight: normal;">Known working configurations</span></small></small></big></big></big></h2>
 <big><big><big><small><small><span style="font-weight: normal;">&nbsp;<small>
 - gcc: <br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 4.3.0 (Fedora Core 9)<br>
 </small></span></small></small></big></big></big><big><big><small><small><span
  style="font-weight: normal;"></span></small></small></big></big><big><big><small><small><span
  style="font-weight: normal;">&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;
@@ -145,13 +179,30 @@ IMPORTANT NOTE </span>:</span><br>
 </span><span style="font-weight: normal;"><span
  style="font-style: italic;"></span><span style="font-style: italic;">&nbsp;&nbsp;&nbsp;
 Type 'c' <span style="color: rgb(204, 102, 0);">many
-times</span> (untill no area is flagged with a '*' -Linux- nor
-highlighted in red -Windows- then type 'g', to generate.</span><br>
+times</span> until no area is flagged with a '*' and three times more
+then type 'g', to generate.</span><br>
 &nbsp;&nbsp;&nbsp; &gt; make<br>
 &nbsp;&nbsp;&nbsp; &gt; sudo make install<br>
 &nbsp;&nbsp; Enjoy !<br>
 <br>
 </span>
+<h2><a class="mozTocH3" name="mozTocId410988"></a><big><span
+ style="font-weight: normal;">Uninstall<br>
+</span></big></h2>
+&nbsp;&nbsp;&nbsp; You can run <span style="font-style: italic;">bbtk-uninstall.sh</span>
+as root.<br>
+<span style="font-weight: bold;">&nbsp;&nbsp;&nbsp; WARNING : </span><br
+ style="font-weight: bold;">
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; This is a brute force **UNSAFE**
+uninstaller which removes all files and folders starting with 'bb' in :<br>
+&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; INSTALL-PREFIX/bin <br>
+&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; INSTALL-PREFIX/lib <br>
+&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; INSTALL-PREFIX/include<br>
+&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; INSTALL-PREFIX/share/bbtk<br>
+&nbsp;&nbsp;&nbsp; However it lists the files found and prompts you
+before proceeding...<br>
+<br>
+<br>
 <hr style="width: 100%; height: 2px;">
 <h1><a class="mozTocH2" name="mozTocId777026"></a><big><big><big><small><small><span
  style="font-weight: normal;">Windows </span></small></small></big></big></big></h1>
@@ -304,7 +355,6 @@ needs to build the BBTK documentation.</li>
   </ul>
 </ul>
 Enjoy !<br>
-</div>
 <div style="text-align: left;">
 <hr style="width: 100%; height: 2px;"></div>
 <div style="text-align: left;">
@@ -843,6 +893,5 @@ set to ON when wxWidgets library is needed with the choices made</td>
   </tbody>
 </table>
 </div>
-</div>
 </body>
 </html>