vorbis/HACKING

   1 Note that these instructions are *not* necessary for distribution
   2 tarballs; they have separate configure/build instructions.
   3
   4 Building this package from CVS is mainly intended for developers.
   5 General users should obtain official distribution packages; both
   6 source and binary distributions are available at
   7 http://www.vorbis.com/.
   8
   9 -----
  10
  11 These are *brief* instructions on how to build this package from CVS.
  12 Yes, there are details left out.
  13
  14 There are generally four steps necessary when building from CVS (i.e.,
  15 a developer's copy):
  16
  17 1. cvs checkout of the sources, or cvs update.  RTFM from your
  18    favorite flavor of CVS documentation; information on the xiph.org
  19    CVS repository can be found at http://www.xiph.org/cvs.html.
  20
  21 2. [re-]generate files such as "configure" and "Makefile.in" with the
  22    GNU autoconf/automake tools.  Run the "autogen.sh" script to
  23    perform this step.
  24
  25    *** IF YOU ARE NOT BUILDING WITH GNU MAKE *AND* GCC: you must set
  26    the AUTOMAKE_FLAGS environment variable to "--include-deps"
  27    before running autogen.sh.  For example:
  28
  29    csh% setenv AUTOMAKE_FLAGS --include-deps
  30    csh% ./autogen.sh
  31      or
  32    sh% AUTOMAKE_FLAGS=--include-deps ./autogen.sh
  33
  34 3. Run configure.  There are several options available; see
  35    "./configure --help" for more information.
  36
  37 4. Run "make" to build the source.
  38
  39 In general, steps 2 and 3 need to be re-run every time any of the
  40 following files are modified (either manually or by a cvs update):
  41
  42           configure.in
  43           acinclude.m4
  44
  45 Running "make clean" after running steps 2 and 3 is generally also
  46 advisable before running step 4.  It isn't *always* necessary, but
  47 unless you understand the workings of autoconf/automake, it's safest
  48 to just do it.