]> Creatis software - crea.git/blob - appli/creaNewProject/NewProject/README.txt
Feature #1763
[crea.git] / appli / creaNewProject / NewProject / 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 #
8 #  This software is governed by the CeCILL-B license under French law and 
9 #  abiding by the rules of distribution of free software. You can  use, 
10 #  modify and/ or redistribute the software under the terms of the CeCILL-B 
11 #  license as circulated by CEA, CNRS and INRIA at the following URL 
12 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html 
13 #  or in the file LICENSE.txt.
14 #
15 #  As a counterpart to the access to the source code and  rights to copy,
16 #  modify and redistribute granted by the license, users are provided only
17 #  with a limited warranty  and the software's author,  the holder of the
18 #  economic rights,  and the successive licensors  have only  limited
19 #  liability. 
20 #
21 #  The fact that you are presently reading this means that you have had
22 #  knowledge of the CeCILL-B license and that you accept its terms.
23 # ------------------------------------------------------------------------ */ 
24
25 USER! Put here your module name.
26 <your Module>
27 (c) CREATIS 2012
28
29 lib will contains as many directories as you need
30 ---
31
32 lib/mySampleLib is just ... a sample (example) library
33 ---------------
34 feel free to remove it, when you are sure you understood how to fill a library.
35 (Don't forget to modity the relevant CMakeLists.txt)
36
37 lib/template_lib is a template you may copy/paste to create your own library
38 ----------------
39 (you may feel like using lib/mySampleLib for doing that...)
40
41 appli contains the source codes for your executables.
42 -----
43
44 bbtk_mySamplePackage_PKG is just ... a sample (example) package
45 ------------------------
46 feel free to remove it, when you are sure you understood how to fill a Package.
47 (Don't forget to modity the relevant CMakeLists.txt)
48
49 bbtk_YourProjectName_PKG is the default package for your project.
50 ------------------------
51 feel free to use it.
52
53 doc : everything you need to generate a full Documentation (with Doxygen,
54 ---
55 with a user designed website, as a lAtEx document ...) 
56 Don't remove, feel free to modify...
57
58 cmake : a set of usefull macro.
59 ----
60 Don't remove, don't modify!
61
62 install : everything needed for making an installer
63 -------
64 Don't remove, don't modify!
65