README-hacking

   1 -*- outline -*-
   2
   3 These notes intend to help people working on the checked-out sources.
   4 These requirements do not apply when building from a distribution tarball.
   5
   6 * Requirements
   7
   8 We've opted to keep only the highest-level sources in the GIT repository.
   9 This eases our maintenance burden, (fewer merges etc.), but imposes more
  10 requirements on anyone wishing to build from the just-checked-out sources.
  11 For example, you have to use the latest stable versions of the maintainer
  12 tools we depend upon, including:
  13
  14 - Automake <http://www.gnu.org/software/automake/>
  15 - Autoconf <http://www.gnu.org/software/autoconf/>
  16 - Bison <http://www.gnu.org/software/bison/>
  17 - Gettext <http://www.gnu.org/software/gettext/>
  18 - Gperf <http://www.gnu.org/software/gperf/>
  19 - Gzip <http://www.gnu.org/software/gzip/>
  20 - Perl <http://www.cpan.org/>
  21 - Tar <http://www.gnu.org/software/tar/>
  22 - Wget <http://www.gnu.org/software/wget/>
  23
  24 Valgrind <http://valgrind.org/> is also highly recommended, if
  25 Valgrind supports your architecture.
  26
  27 Only building the initial full source tree will be a bit painful.
  28 Later, a plain `git-pull && make' should be sufficient.
  29
  30 * First GIT checkout
  31
  32 Obviously, if you are reading these notes, you did manage to check out
  33 this package from GIT.  The next step is to get other files needed to
  34 build, which are extracted from other source packages:
  35
  36         $ ./bootstrap
  37
  38 And there you are!  Just
  39
  40         $ ./configure
  41         $ make
  42         $ make check
  43
  44 At this point, there should be no difference between your local copy,
  45 and the GIT master copy:
  46
  47         $ git-diff
  48
  49 should output no difference.
  50
  51 Enjoy!
  52
  53 -----
  54
  55 Copyright (C) 2002-2007 Free Software Foundation, Inc.
  56
  57 This program is free software; you can redistribute it and/or modify
  58 it under the terms of the GNU General Public License as published by
  59 the Free Software Foundation; either version 2, or (at your option)
  60 any later version.
  61
  62 This program is distributed in the hope that it will be useful,
  63 but WITHOUT ANY WARRANTY; without even the implied warranty of
  64 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  65 GNU General Public License for more details.
  66
  67 You should have received a copy of the GNU General Public License
  68 along with this program; if not, write to the Free Software
  69 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  70 02110-1301, USA.