Annotation of /libgig/trunk/README

Content
=======
  libgig actually consists of three parts:

  - RIFF classes (RIFF.h, RIFF.cpp): Provides convenient methods to parse and
                                     access arbitrary RIFF files.
  - DLS classes (DLS.h, DLS.cpp):    They're using the RIFF classes to parse
                                     DLS (Downloadable Sounds) Level 1 and 2
                                     files and provide abstract access to the
                                     data.
  - gig classes (gig.h, gig.cpp):    These are based on the DLS classes and
                                     provide the neccessary extensions for
                                     the Gigasampler file format.

Requirements
============
  I simply used automake & co this time so you will need to have automake,
  autoconf and libtool installed. I used the following versions:

    automake  1.6.3
    autoconf  2.57

  If you want to compile the 'gigextract' application that comes with these
  sources then you will additionally need to have libaudiofile installed (I
  used version 0.2.3).

Non-POSIX systems
=================
  If you don't have a POSIX system, you have to set 'POSIX' to '0' in RIFF.h.
  Instead of using POSIX calls then standard C calls will be used for file
  access. This applies e.g. to Windows systems.

Compiling:
==========
 - Use './configure && make all' to compile the library and all tools and
   demo applications.

 - Beside the actual library there are four applications:

     gigdump:     Demo app that prints out the content of a .gig file.
     gigextract:  Extracts samples from a .gig file.
     dlsdump:     Demo app that prints out the content of a DLS file.
     rifftree:    Tool that prints out the RIFF tree of an arbitrary RIFF
                  file.

 - If you have Doxygen installed you can generate the API documentation by
   just running 'doxygen' in the sources' top level directory.

 - 'make distclean' to clean up everything again

Patches
=======
  If you find bugs or have improvements, your patches are always welcome!
  Send them either directly to me or to the LinuxSampler developer's mailing
  list <linuxsampler-devel@lists.sourceforge.net>.

Credits
=======
  This library is based on the reverse engineering work of Paul Kellett and
  Ruben van Royen. Thanks for your great work!

 Christian Schoenebeck <cuse@users.sourceforge.net>
1	schoenebeck	2	Content
2			=======
3			libgig actually consists of three parts:
4
5			- RIFF classes (RIFF.h, RIFF.cpp): Provides convenient methods to parse and
6			access arbitrary RIFF files.
7			- DLS classes (DLS.h, DLS.cpp): They're using the RIFF classes to parse
8			DLS (Downloadable Sounds) Level 1 and 2
9			files and provide abstract access to the
10			data.
11			- gig classes (gig.h, gig.cpp): These are based on the DLS classes and
12			provide the neccessary extensions for
13			the Gigasampler file format.
14
15			Requirements
16			============
17			I simply used automake & co this time so you will need to have automake,
18			autoconf and libtool installed. I used the following versions:
19
20			automake 1.6.3
21			autoconf 2.57
22
23			If you want to compile the 'gigextract' application that comes with these
24			sources then you will additionally need to have libaudiofile installed (I
25			used version 0.2.3).
26
27			Non-POSIX systems
28			=================
29			If you don't have a POSIX system, you have to set 'POSIX' to '0' in RIFF.h.
30			Instead of using POSIX calls then standard C calls will be used for file
31	schoenebeck	11	access. This applies e.g. to Windows systems.
32	schoenebeck	2
33			Compiling:
34			==========
35	schoenebeck	11	- Use './configure && make all' to compile the library and all tools and
36			demo applications.
37	schoenebeck	2
38			- Beside the actual library there are four applications:
39
40			gigdump: Demo app that prints out the content of a .gig file.
41			gigextract: Extracts samples from a .gig file.
42			dlsdump: Demo app that prints out the content of a DLS file.
43			rifftree: Tool that prints out the RIFF tree of an arbitrary RIFF
44			file.
45
46			- If you have Doxygen installed you can generate the API documentation by
47			just running 'doxygen' in the sources' top level directory.
48
49			- 'make distclean' to clean up everything again
50
51	schoenebeck	11	Patches
52			=======
53			If you find bugs or have improvements, your patches are always welcome!
54			Send them either directly to me or to the LinuxSampler developer's mailing
55			list <linuxsampler-devel@lists.sourceforge.net>.
56
57			Credits
58			=======
59			This library is based on the reverse engineering work of Paul Kellett and
60			Ruben van Royen. Thanks for your great work!
61
62	schoenebeck	2	Christian Schoenebeck <cuse@users.sourceforge.net>