kernel/appli/bbCreatePackage/void-Package/README.txt

   1 This is a void bbtk package structure.
   2
   3 You should have this file tree :
   4
   5 .
   6 |-- CMakeLists.txt
   7 |-- Configure.cmake
   8 |-- PackageConfig.cmake.in
   9 |-- README.txt
  10 |-- UsePackage.cmake.in
  11 |-- bbs
  12 |   |-- CMakeLists.txt
  13 |   |-- appli
  14 |   `-- boxes
  15 |-- data
  16 |   `-- CMakeLists.txt
  17 |-- doc
  18 |   |-- CMakeLists.txt
  19 |   |-- bbdoc
  20 |   |   |-- CMakeLists.txt
  21 |   |   `-- header.html.in
  22 |   `-- doxygen
  23 |       |-- CMakeLists.txt
  24 |       |-- DoxyMainPage.txt.in
  25 |       `-- Doxyfile.txt.in
  26 `-- src
  27     `-- CMakeLists.txt
  28
  29 To use it :
  30
  31 * Edit the root CMakeLists.txt file to customize your package build settings
  32   (instructions inside the file)
  33
  34 * Put your c++/xml boxes sources in 'src'
  35   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}
  36
  37 * Put your script-defined boxes in 'bbs/boxes'.
  38   Use the convention : If the name of your box is 'Box' then call the file 'bbBox.bbs'
  39
  40 * Put your script-defined applications in 'bbs/appli'.
  41
  42 * Put your data in 'data'
  43
  44 * 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'.
  45
  46 * You can customize the main page of your doxygen doc by editing the file 'doc/doxygen/DoxyMainPage.txt.in'.
  47
  48 * 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).
  49
  50 THAT'S ALL FOLKS !
  51
  52