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