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 Note the requirements to build the released archive are much less and
  12 are just the requirements of the standard ./configure && make procedure.
  13 Specific development tools and versions will be checked for and listed by
  14 the bootstrap script.  See README-prereq for specific notes on obtaining
  15 these prerequisite tools.
  16
  17 Valgrind <http://valgrind.org/> is also highly recommended, if
  18 Valgrind supports your architecture. See also README-valgrind.
  19
  20 While building from a just-cloned source tree may require installing a
  21 few prerequisites, later, a plain `git pull && make' should be sufficient.
  22
  23 * First GIT checkout
  24
  25 You can get a copy of the source repository like this:
  26
  27         $ git clone git://git.sv.gnu.org/cppi
  28         $ cd cppi
  29
  30 The next step is to get and check other files needed to build,
  31 which are extracted from other source packages:
  32
  33         $ ./bootstrap
  34
  35 And there you are!  Just
  36
  37         $ ./configure #[--enable-gcc-warnings]
  38         $ make
  39         $ make check
  40
  41 At this point, there should be no difference between your local copy,
  42 and the GIT master copy:
  43
  44         $ git diff
  45
  46 should output no difference.
  47
  48 Enjoy!
  49
  50 -----
  51
  52 Copyright (C) 2002-2021, 2023-2024 Free Software Foundation, Inc.
  53
  54 This program is free software: you can redistribute it and/or modify
  55 it under the terms of the GNU General Public License as published by
  56 the Free Software Foundation, either version 3 of the License, or
  57 (at your option) any later version.
  58
  59 This program is distributed in the hope that it will be useful,
  60 but WITHOUT ANY WARRANTY; without even the implied warranty of
  61 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  62 GNU General Public License for more details.
  63
  64 You should have received a copy of the GNU General Public License
  65 along with this program.  If not, see <http://www.gnu.org/licenses/>.