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

Diff of /libgig/trunk/README

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

revision 11 by schoenebeck, Sun Nov 16 17:47:00 2003 UTC revision 312 by schoenebeck, Fri Nov 26 19:24:18 2004 UTC
# Line 9  Content Line 9  Content
9                                       files and provide abstract access to the                                       files and provide abstract access to the
10                                       data.                                       data.
11    - gig classes (gig.h, gig.cpp):    These are based on the DLS classes and    - gig classes (gig.h, gig.cpp):    These are based on the DLS classes and
12                                       provide the neccessary extensions for                                       provide the necessary extensions for
13                                       the Gigasampler file format.                                       the Gigasampler file format.
14    
15  Requirements  Requirements
# Line 21  Requirements Line 21  Requirements
21      autoconf  2.57      autoconf  2.57
22    
23    If you want to compile the 'gigextract' application that comes with these    If you want to compile the 'gigextract' application that comes with these
24    sources then you will additionally need to have libaudiofile installed (I    sources then you will additionally need to have libaudiofile (>= 0.2.3)
25    used version 0.2.3).    or libsndfile (>= 1.0.2) installed. Note: for Windows systems only
26      libsndfile is available.
27    
28  Non-POSIX systems  Non-POSIX systems
29  =================  =================
# Line 30  Non-POSIX systems Line 31  Non-POSIX systems
31    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
32    access. This applies e.g. to Windows systems.    access. This applies e.g. to Windows systems.
33    
34  Compiling:  Compiling
35  ==========  =========
  - Use './configure && make all' to compile the library and all tools and  
    demo applications.  
36    
37   - Beside the actual library there are four applications:    You can either compile the sources and install the library directly on
38      your system or you can create Redhat or Debian packages.
39    
40      a) Compiling and installing directly
41    
42      Use 'make -f Makefile.cvs && ./configure && make' to compile the library,
43      all tools, demo applications, documentation and install them with
44      'make install'. You can use 'make distclean && make -f Makefile.cvs clean'
45      to clean up everything again.
46    
47      b) Creating Debian packages
48    
49      Use 'make -f Makefile.cvs && dpkg-buildpackage -rfakeroot -b' to compile
50      and create the Debian packages. This will generate 3 Debian packages:
51    
52        libgig:      Contains the shared library files.
53        libgig-dev:  Contains the header files and documentation for building
54                     applications using libgig.
55        gigtools:    Contains the tools and demo applications.
56    
57      You can use 'fakeroot debian/rules clean && make -f Makefile.cvs clean'
58      to clean up everything again.
59    
60      c) Creating Redhat packages
61    
62      You need to have the rpmbuild tool installed and properly configured to
63      create RPM packages. To create the RPM packages do the following:
64    
65        * Get .spec file generated by ./configure and edit it as appropriate.
66    
67        * Copy the source tarball to "/usr/src/<rpmdir>/SOURCES" directory,
68          where <rpmdir> is dependent to the system you are using. For SuSE
69          <rmpdir> will be "packages", for Mandrake <rpmdir> is "RPM" and for
70          Redhat / Fedora <rpmdir> always equals "redhat".
71    
72        * Build the rpm(s) by invoking 'rpmbuild -bb <specfile>' from the
73          command line.
74    
75      On success, the resulting rpm(s) can usually be found under the proper
76      "/usr/src/<rpmdir>/RPMS/<arch>" directory.
77    
78    Tools
79    =====
80    
81     Beside the actual library there are four applications:
82    
83       gigdump:     Demo app that prints out the content of a .gig file.       gigdump:     Demo app that prints out the content of a .gig file.
84       gigextract:  Extracts samples from a .gig file.       gigextract:  Extracts samples from a .gig file.
# Line 43  Compiling: Line 86  Compiling:
86       rifftree:    Tool that prints out the RIFF tree of an arbitrary RIFF       rifftree:    Tool that prints out the RIFF tree of an arbitrary RIFF
87                    file.                    file.
88    
89   - If you have Doxygen installed you can generate the API documentation by  API Documentation
90     just running 'doxygen' in the sources' top level directory.  =================
91    
92   - 'make distclean' to clean up everything again   If you have Doxygen installed you can generate the API documentation by
93     running 'make docs' in the sources' top level directory. The API
94     documentation will be generated in the 'doc' subdirectory.
95    
96  Patches  Patches
97  =======  =======
Legend:
Removed from v.11  
changed lines
  Added in v.312
  ViewVC Help
Powered by ViewVC