Import upstream version 0.99.2

[fmit.git] / libs / Music / README

diff --git a/libs/Music/README b/libs/Music/README
new file mode 100644 (file)
index 0000000..67b5eaf
--- /dev/null
+++ b/libs/Music/README
@@ -0,0 +1,64 @@
+
+
+------------------------------ For YAMakefile user -----------------------------
+Here are some information about the tool used for managing this project
+
+Common goals [and alias]
+       clean
+       distclean
+       maintainer-clean [burn]
+       backup
+       archive [dist pkg]
+               make a tar.bz2 archive with working directory
+               (as it is, without cleaning/removing any file)
+       install
+       uninstall
+       check
+               check for tools/SDKs/libraries
+               should be runned before 'make'
+       configure
+               set compilation features and run check goal
+       rpm
+               build a Mandrake rpm
+               (maybe compatible with other distributions)
+       copyright
+               add Copyright names to source files
+               copyright names in '"': (ex. "Linda Fiorentino")
+               to add a name fast in all sources:
+                       make COPYRIGHT_AUTHOR="Claire Forlani" copyright
+               use COPYRIGHT_FILES for completing source file list
+               use COPYRIGHT_COMMENT to set comment symbole
+               to add license statement for unrecognized file type:
+                       make COPYRIGHT_FILES=main.cpp COPYRIGHT_COMMENT="//" copyright
+       license
+               add License statement to source files
+       COPYING [copying]
+               generate the COPYING file with the license set by LICENSE variable
+               see http://www.opensource.org/licenses and 'make check' for your choice
+       INSTALL (the file !)
+               generate the INSTALL file for standard installation instructions for
+               a project using YAMakefile
+       yam-unroll
+               remove yam install depedency by generating Makefile.unroll
+               execute: yam -uk -t YAM_TYPE
+
+How to use features
+       nothing tell better than a sample:
+       CONFIGURE_AVAILABLE_FEATURES += "gui, BUILD_GUI, build the graphical, user interface" "arts, USE_ARTS, use arts sound server"
+
+Some usefull information
+
+       Auto set variable criterias
+
+               GCC_MODE
+                       check if a 'main.*(.*int.*,.*char\*.*)' is present in sources
+               GCC_QT
+                       check if a '^#include.*qapplication.h>' exist
+               GCC_QT_USE_THREAD
+                       check if a '^\#include.*qthread.h>' exist
+               QT_OBJECTS
+                       grep -al 'Q_OBJECT' *.h
+
+Known bugs
+       in any ways, file names containing whitespace are unsupported
+