wt/bbtk_mySamplePackage_PKG/README.txt

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