packages/vtk/README.txt

   1 # ---------------------------------------------------------------------
   2 #
   3 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   4 #                        pour la SantÈ)
   5 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   6 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   7 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   8 #
   9 #  This software is governed by the CeCILL-B license under French law and
  10 #  abiding by the rules of distribution of free software. You can  use,
  11 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  12 #  license as circulated by CEA, CNRS and INRIA at the following URL
  13 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  14 #  or in the file LICENSE.txt.
  15 #
  16 #  As a counterpart to the access to the source code and  rights to copy,
  17 #  modify and redistribute granted by the license, users are provided only
  18 #  with a limited warranty  and the software's author,  the holder of the
  19 #  economic rights,  and the successive licensors  have only  limited
  20 #  liability.
  21 #
  22 #  The fact that you are presently reading this means that you have had
  23 #  knowledge of the CeCILL-B license and that you accept its terms.
  24 # ------------------------------------------------------------------------ */
  25
  26
  27 This is a void bbtk package structure.
  28
  29 You should have this file tree :
  30
  31 void
  32 |-- CMakeLists.txt
  33 |-- Configure.cmake
  34 |-- PackageConfig.cmake.in
  35 |-- README.txt
  36 |-- UsePackage.cmake.in
  37 |-- bbs
  38 |   |-- CMakeLists.txt
  39 |   |-- appli
  40 |   `-- boxes
  41 |-- doc
  42 |   |-- CMakeLists.txt
  43 |   |-- bbdoc
  44 |   |   |-- CMakeLists.txt
  45 |   |   `-- header.html.in
  46 |   `-- doxygen
  47 |       |-- CMakeLists.txt
  48 |       |-- DoxyMainPage.txt.in
  49 |       `-- Doxyfile.txt.in
  50 `-- src
  51     `-- CMakeLists.txt
  52
  53 To use it :
  54
  55 * Rename the 'void' folder (where this file is) at your convenience
  56
  57 * Edit the root CMakeLists.txt file and fill in the package informations following the instructions inside the file
  58
  59 * Put your c++/xml boxes sources in 'src'
  60
  61 * Put your script-defined boxes in 'bbs/boxes'.
  62   Use the convention : If the name of the defined box is 'Box' then call the file 'bbBox.bbs'
  63
  64 * Put your script-defined applications in 'bbs/appli'.
  65
  66 * You can customize the header of your package html doc by editing the file 'doc/bbdoc/header.html.in'. You must put html code in this file (or edit it with an html editor). You can include images or links to other html pages. The images and pages must be put in the folder 'doc/bbdoc' and will be properly installed. The same way, you can link to these images or pages in your boxes descriptions without giving any path. If you create subdirs for your material then you have to install the materials yourself by editing the CMakeLists.txt and links must use path with are relative to 'doc/bbdoc'.
  67
  68 * You can customize the main page of your doxygen doc by editing the file 'doc/doxygen/DoxyMainPage.txt.in'.
  69
  70 * Advanced settings : you can add custom cmake settings for your package installation process by CMakeCreateFindPackage in the files PackageConfig.cmake.in and UsePackage.cmake.in (see CMakeCreateFindPackage doc).
  71
  72 THAT'S ALL FOLKS !
  73
  74