diff options
Diffstat (limited to 'README-hacking')
| -rw-r--r-- | README-hacking | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/README-hacking b/README-hacking new file mode 100644 index 000000000..6a2714ad4 --- /dev/null +++ b/README-hacking @@ -0,0 +1,71 @@ +-*- outline -*- + +These notes intend to help people working on the checked-out sources. +These requirements do not apply when building from a distribution tarball. + +* Requirements + +We've opted to keep only the highest-level sources in the GIT repository. +This eases our maintenance burden, (fewer merges etc.), but imposes more +requirements on anyone wishing to build from the just-checked-out sources. +For example, you have to use the latest stable versions of the maintainer +tools we depend upon, including: + +- Automake <http://www.gnu.org/software/automake/> +- Autoconf <http://www.gnu.org/software/autoconf/> +- Bison <http://www.gnu.org/software/bison/> +- Gettext <http://www.gnu.org/software/gettext/> +- Gzip <http://www.gnu.org/software/gzip/> +- Tar <http://www.gnu.org/software/tar/> +- Wget <http://www.gnu.org/software/wget/> + +As of this writing, the latest stable version of Gzip is 1.2.4 but we +suggest using test version 1.3.5 (or later, if one becomes available). + +Valgrind <http://valgrind.org/> is also highly recommended, if +Valgrind supports your architecture. + +Only building the initial full source tree will be a bit painful. +Later, a plain `git-pull && make' should be sufficient. + +* First GIT checkout + +Obviously, if you are reading these notes, you did manage to check out +this package from GIT. The next step is to get other files needed to +build, which are extracted from other source packages: + + $ ./bootstrap + +And there you are! Just + + $ ./configure + $ make + $ make check + +At this point, there should be no difference between your local copy, +and the GIT master copy: + + $ git-diff + +should output no difference. + +Enjoy! + +----- + +Copyright (C) 2002-2007 Free Software Foundation, Inc. + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2, or (at your option) +any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +02110-1301, USA. |