HACKING 1.7 KB

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