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