/[svn]/libgig/trunk/README

Diff of /libgig/trunk/README

Parent Directory | Revision Log | View Patch Patch

-revision 530 by schoenebeck,
Mon May  9 14:09:16 2005 UTC
+revision 923 by schoenebeck,
Thu Oct 19 19:01:13 2006 UTC
 Line 1
+ Home
+ ====
+   You can always find the latest version of libgig at:
+   http://stud.hs-heilbronn.de/~cschoene/projects/libgig/
  Content
  =======
    libgig actually consists of three parts:
-Line 12 
 Content
+Line 17 
 Content
                                       provide the necessary extensions for
                                       the Gigasampler file format.
+   Beside the actual library there are four example 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.
+   Since version 3.0.0 libgig also provides write support, that is for
+   creating modifying .gig, DLS and RIFF files.
  Requirements
  ============
-   I simply used automake & co this time so you will need to have automake,
+   POSIX systems (e.g. Linux, OS X):
-   autoconf and libtool installed. I used the following versions:
+   ---------------------------------
-     automake  1.6.3
+   You need at least to have libtool installed to be able to build the
-     autoconf  2.57
+   library with "./configure && make".
-   If you want to compile the 'gigextract' application that comes with these
+   Additionally you need to have either libaudiofile (>= 0.2.3) or
-   sources then you will additionally need to have libaudiofile (>= 0.2.3)
+   libsndfile (>= 1.0.2) installed which is mandatory to be able to compile
-   or libsndfile (>= 1.0.2) installed. Note: for Windows systems only
+   the 'gigextract' example application. But of course 'gigextract' is still
-   libsndfile is available.
+   just an example application, so it would make sense to compile it only if
+   one of those libraries are available. That would remove that hard
+   dependency to those two libs. But that's not a priority for me now.
+   Note: for Windows systems only libsndfile is available.
+   If you want to regenerate all autotools build files (that is configure,
+   Makefile.in, etc.) then you need to have automake (>= 1.5) and autoconf
+   installed.
+   Non-POSIX systems (e.g. Windows):
+   ---------------------------------
- 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. I would appreciate if
-Line 36 
 Non-POSIX systems
+Line 60 
 Non-POSIX systems
  Compiling
  =========
    You can either compile the sources and install the library directly on
    your system or you can create Redhat or Debian packages.
    a) Compiling and installing directly
-   Use 'make -f Makefile.cvs && ./configure && make' to compile the library,
+   Call './configure && make' on the console to compile the library, all
-   all tools, demo applications, documentation and install them with
+   tools and demo applications, documentation and install them with
-   'make install'. You can use 'make distclean && make -f Makefile.cvs clean'
+   'make install'. The latter has to be called as root.
-   to clean up everything again.
+   If you are compiling from CVS you have to call 'make -f Makefile.cvs'
+   to generate all autotools build files before calling
+   './configure && make'.
+   You can use 'make distclean' and probably 'make -f Makefile.cvs clean'
+   to clean up everything again. The latter will also delete all automatic
+   generated autools build files.
    b) Creating Debian packages
-   Use 'make -f Makefile.cvs && dpkg-buildpackage -rfakeroot -b' to compile
+   Use 'dpkg-buildpackage -rfakeroot -b' to compile and create the Debian
-   and create the Debian packages. This will generate 3 Debian packages:
+   packages. This will generate 3 Debian packages:
      libgig:      Contains the shared library files.
      libgig-dev:  Contains the header files and documentation for building
                   applications using libgig.
      gigtools:    Contains the tools and demo applications.
-   You can use 'fakeroot debian/rules clean && make -f Makefile.cvs clean'
+   You can use 'fakeroot debian/rules clean' to clean up everything again.
-   to clean up everything again.
    c) Creating Redhat packages
-Line 78 
 Compiling
+Line 107 
 Compiling
    On success, the resulting rpm(s) can usually be found under the proper
    "/usr/src/<rpmdir>/RPMS/<arch>" directory.
- Tools
+ Test Cases
- =====
+ ==========
+   The libgig sources come with a tiny console application which allows to
+   automatically test libgig's functions on your system. This test
+   application is not compiled by default, you have to compile it explicitly
+   with the following commands on the console (cppunit has to be installed):
+     cd src/testcases
+     make libgigtests
+   and then run the test application from the same directory with:
-  Beside the actual library there are four applications:
+     ./libgigtests
-      gigdump:     Demo app that prints out the content of a .gig file.
+ License
-      gigextract:  Extracts samples from a .gig file.
+ =======
-      dlsdump:     Demo app that prints out the content of a DLS file.
+   libgig and its tools are released under the GNU General Public License.
-      rifftree:    Tool that prints out the RIFF tree of an arbitrary RIFF
-                   file.
  API Documentation
  =================
+   If you have Doxygen installed you can generate the API documentation by
-  If you have Doxygen installed you can generate the API documentation by
+   running 'make docs' in the sources' top level directory. The API
-  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.
  Patches
  =======
-   If you find bugs or have improvements, your patches are always welcome!
+   If you have bug fixes or 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>.
+ Bugs
+ ====
+   Please use http://bugs.linuxsampler.org to check and report possible bugs.
+   You might also try to run the "Test Cases" coming with libgig (see above),
+   especially in case you are running on an odd system.
  Credits
  =======
    The initial library was based on the reverse engineering effort of
    Paul Kellett and Ruben van Royen. We owe current support for the quite new
    Gigasampler v3 format to Andreas Persson. Please also have a look at the
-   ChangeLog for all those who contributed. Thanks for your great work!
+   ChangeLog for all those who contributed. Thanks to all of you for your
+   great work!
   Christian Schoenebeck <cuse@users.sourceforge.net>

 Legend:



Removed from v.530
 


changed lines


 
Added in v.923
 Legend:



Removed from v.530
 


changed lines


 
Added in v.923
-Removed from v.530
+Added in v.923

	ViewVC Help
Powered by ViewVC