/[svn]/libgig/trunk/README
ViewVC logotype

Diff of /libgig/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 650 by schoenebeck, Wed Jun 15 12:51:12 2005 UTC revision 923 by schoenebeck, Thu Oct 19 19:01:13 2006 UTC
# Line 1  Line 1 
1    Home
2    ====
3      You can always find the latest version of libgig at:
4      http://stud.hs-heilbronn.de/~cschoene/projects/libgig/
5    
6  Content  Content
7  =======  =======
8    libgig actually consists of three parts:    libgig actually consists of three parts:
# Line 20  Content Line 25  Content
25      rifftree:    Tool that prints out the RIFF tree of an arbitrary RIFF      rifftree:    Tool that prints out the RIFF tree of an arbitrary RIFF
26                   file.                   file.
27    
28      Since version 3.0.0 libgig also provides write support, that is for
29      creating modifying .gig, DLS and RIFF files.
30    
31  Requirements  Requirements
32  ============  ============
   
33    POSIX systems (e.g. Linux, OS X):    POSIX systems (e.g. Linux, OS X):
34    ---------------------------------    ---------------------------------
35    
# Line 39  Requirements Line 46  Requirements
46    
47    If you want to regenerate all autotools build files (that is configure,    If you want to regenerate all autotools build files (that is configure,
48    Makefile.in, etc.) then you need to have automake (>= 1.5) and autoconf    Makefile.in, etc.) then you need to have automake (>= 1.5) and autoconf
49    installed.      installed.
50    
51    Non-POSIX systems (e.g. Windows):    Non-POSIX systems (e.g. Windows):
52    ---------------------------------    ---------------------------------
53      
54    If you don't have a POSIX system, you have to set 'POSIX' to '0' in RIFF.h.    If you don't have a POSIX system, you have to set 'POSIX' to '0' in RIFF.h.
55    Instead of using POSIX calls then standard C calls will be used for file    Instead of using POSIX calls then standard C calls will be used for file
56    access. This applies e.g. to Windows systems. I would appreciate if    access. This applies e.g. to Windows systems. I would appreciate if
# Line 53  Requirements Line 60  Requirements
60    
61  Compiling  Compiling
62  =========  =========
   
63    You can either compile the sources and install the library directly on    You can either compile the sources and install the library directly on
64    your system or you can create Redhat or Debian packages.    your system or you can create Redhat or Debian packages.
65    
# Line 101  Compiling Line 107  Compiling
107    On success, the resulting rpm(s) can usually be found under the proper    On success, the resulting rpm(s) can usually be found under the proper
108    "/usr/src/<rpmdir>/RPMS/<arch>" directory.    "/usr/src/<rpmdir>/RPMS/<arch>" directory.
109    
110    Test Cases
111    ==========
112      The libgig sources come with a tiny console application which allows to
113      automatically test libgig's functions on your system. This test
114      application is not compiled by default, you have to compile it explicitly
115      with the following commands on the console (cppunit has to be installed):
116    
117        cd src/testcases
118        make libgigtests
119    
120      and then run the test application from the same directory with:
121    
122        ./libgigtests
123    
124    License
125    =======
126      libgig and its tools are released under the GNU General Public License.
127    
128  API Documentation  API Documentation
129  =================  =================
130      If you have Doxygen installed you can generate the API documentation by
131   If you have Doxygen installed you can generate the API documentation by    running 'make docs' in the sources' top level directory. The API
132   running 'make docs' in the sources' top level directory. The API    documentation will be generated in the 'doc' subdirectory.
  documentation will be generated in the 'doc' subdirectory.  
133    
134  Patches  Patches
135  =======  =======
136    If you find bugs or have improvements, your patches are always welcome!    If you have bug fixes or improvements, your patches are always welcome!
137    Send them either directly to me or to the LinuxSampler developer's mailing    Send them either directly to me or to the LinuxSampler developer's mailing
138    list <linuxsampler-devel@lists.sourceforge.net>.    list <linuxsampler-devel@lists.sourceforge.net>.
139    
140    Bugs
141    ====
142      Please use http://bugs.linuxsampler.org to check and report possible bugs.
143      You might also try to run the "Test Cases" coming with libgig (see above),
144      especially in case you are running on an odd system.
145    
146  Credits  Credits
147  =======  =======
148    The initial library was based on the reverse engineering effort of    The initial library was based on the reverse engineering effort of
149    Paul Kellett and Ruben van Royen. We owe current support for the quite new    Paul Kellett and Ruben van Royen. We owe current support for the quite new
150    Gigasampler v3 format to Andreas Persson. Please also have a look at the    Gigasampler v3 format to Andreas Persson. Please also have a look at the
151    ChangeLog for all those who contributed. Thanks for your great work!    ChangeLog for all those who contributed. Thanks to all of you for your
152      great work!
153    
154   Christian Schoenebeck <cuse@users.sourceforge.net>   Christian Schoenebeck <cuse@users.sourceforge.net>
Legend:
Removed from v.650  
changed lines
  Added in v.923
  ViewVC Help
Powered by ViewVC