]> Creatis software - bbtk.git/blob - packages/vtk/README.txt
*** empty log message ***
[bbtk.git] / packages / vtk / README.txt
1 This is a void bbtk package structure.
2
3 You should have this file tree :
4
5 void
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 |-- doc
16 |   |-- CMakeLists.txt
17 |   |-- bbdoc
18 |   |   |-- CMakeLists.txt
19 |   |   `-- header.html.in
20 |   `-- doxygen
21 |       |-- CMakeLists.txt
22 |       |-- DoxyMainPage.txt.in
23 |       `-- Doxyfile.txt.in
24 `-- src
25     `-- CMakeLists.txt
26
27 To use it :
28
29 * Rename the 'void' folder (where this file is) at your convenience
30
31 * Edit the root CMakeLists.txt file and fill in the package informations following the instructions inside the file
32
33 * Put your c++/xml boxes sources in 'src'
34
35 * Put your script-defined boxes in 'bbs/boxes'. 
36   Use the convention : If the name of the defined box is 'Box' then call the file 'bbBox.bbs'
37
38 * Put your script-defined applications in 'bbs/appli'. 
39
40 * 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'.
41
42 * You can customize the main page of your doxygen doc by editing the file 'doc/doxygen/DoxyMainPage.txt.in'.
43
44 * 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).
45
46 THAT'S ALL FOLKS !
47
48