--- libgig/trunk/README 2003/11/16 17:47:00 11 +++ libgig/trunk/README 2004/08/18 12:11:26 220 @@ -21,8 +21,9 @@ 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). + sources then you will additionally need to have libaudiofile (>= 0.2.3) + or libsndfile (>= 1.0.2) installed. Note: for Windows systems only + libsndfile is available. Non-POSIX systems ================= @@ -30,12 +31,54 @@ 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. +Compiling +========= - - Beside the actual library there are four applications: + 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, + all tools, demo applications, documentation and install them with + 'make install'. You can use 'make distclean && make -f Makefile.cvs clean' + to clean up everything again. + + b) Creating Debian packages + + Use 'make -f Makefile.cvs && dpkg-buildpackage -rfakeroot -b' to compile + and create the Debian 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' + to clean up everything again. + + c) Creating Redhat packages + + You need to have the rpmbuild tool installed and properly configured to + create RPM packages. To create the RPM packages do the following: + + * Get .spec file generated by ./configure and edit it as appropriate. + + * Copy the source tarball to "/usr/src//SOURCES" directory, + where is dependent to the system you are using. For SuSE + will be "packages", for Mandrake is "RPM" and for + Redhat / Fedora always equals "redhat". + + * Build the rpm(s) by invoking 'rpmbuild -bb ' from the + command line. + + On success, the resulting rpm(s) can usually be found under the proper + "/usr/src//RPMS/" directory. + +Tools +===== + + 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. @@ -43,10 +86,12 @@ 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. +API Documentation +================= - - 'make distclean' to clean up everything again + If you have Doxygen installed you can generate the API documentation by + just running 'doxygen' in the sources' top level directory. The API + documentation will be generated in the 'html' subdirectory. Patches =======