libs/Music/README

   1
   2
   3 ------------------------------ For YAMakefile user -----------------------------
   4 Here are some information about the tool used for managing this project
   5
   6 Common goals [and alias]
   7         clean
   8         distclean
   9         maintainer-clean [burn]
  10         backup
  11         archive [dist pkg]
  12                 make a tar.bz2 archive with working directory
  13                 (as it is, without cleaning/removing any file)
  14         install
  15         uninstall
  16         check
  17                 check for tools/SDKs/libraries
  18                 should be runned before 'make'
  19         configure
  20                 set compilation features and run check goal
  21         rpm
  22                 build a Mandrake rpm
  23                 (maybe compatible with other distributions)
  24         copyright
  25                 add Copyright names to source files
  26                 copyright names in '"': (ex. "Linda Fiorentino")
  27                 to add a name fast in all sources:
  28                         make COPYRIGHT_AUTHOR="Claire Forlani" copyright
  29                 use COPYRIGHT_FILES for completing source file list
  30                 use COPYRIGHT_COMMENT to set comment symbole
  31                 to add license statement for unrecognized file type:
  32                         make COPYRIGHT_FILES=main.cpp COPYRIGHT_COMMENT="//" copyright
  33         license
  34                 add License statement to source files
  35         COPYING [copying]
  36                 generate the COPYING file with the license set by LICENSE variable
  37                 see http://www.opensource.org/licenses and 'make check' for your choice
  38         INSTALL (the file !)
  39                 generate the INSTALL file for standard installation instructions for
  40                 a project using YAMakefile
  41         yam-unroll
  42                 remove yam install depedency by generating Makefile.unroll
  43                 execute: yam -uk -t YAM_TYPE
  44
  45 How to use features
  46         nothing tell better than a sample:
  47         CONFIGURE_AVAILABLE_FEATURES += "gui, BUILD_GUI, build the graphical, user interface" "arts, USE_ARTS, use arts sound server"
  48
  49 Some usefull information
  50
  51         Auto set variable criterias
  52
  53                 GCC_MODE
  54                         check if a 'main.*(.*int.*,.*char\*.*)' is present in sources
  55                 GCC_QT
  56                         check if a '^#include.*qapplication.h>' exist
  57                 GCC_QT_USE_THREAD
  58                         check if a '^\#include.*qthread.h>' exist
  59                 QT_OBJECTS
  60                         grep -al 'Q_OBJECT' *.h
  61
  62 Known bugs
  63         in any ways, file names containing whitespace are unsupported
  64