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 USER! Put here your module name.
  28 <your Module>
  29 (c) CREATIS 2012
  30
  31 lib will contains as many directories as you need
  32 ---
  33
  34 lib/mySampleLib is just ... a sample (example) library
  35 ---------------
  36 feel free to remove it, when you are sure you understood how to fill a library.
  37 (Don't forget to modity the relevant CMakeLists.txt)
  38
  39 lib/template_lib is a template you may copy/paste to create your own library
  40 ----------------
  41 (you may feel like using lib/mySampleLib for doing that...)
  42
  43 appli contains the source codes for your executables.
  44 -----
  45
  46 bbtk_mySamplePackage_PKG is just ... a sample (example) package
  47 ------------------------
  48 feel free to remove it, when you are sure you understood how to fill a Package.
  49 (Don't forget to modity the relevant CMakeLists.txt)
  50
  51 bbtk_YourProjectName_PKG is the default package for your project.
  52 ------------------------
  53 feel free to use it.
  54
  55 doc : everything you need to generate a full Documentation (with Doxygen,
  56 ---
  57 with a user designed website, as a lAtEx document ...)
  58 Don't remove, feel free to modify...
  59
  60 cmake : a set of usefull macro.
  61 ----
  62 Don't remove, don't modify!
  63
  64 install : everything needed for making an installer
  65 -------
  66 Don't remove, don't modify!
  67