-*- outline -*-

These notes intend to help people working on the checked-out sources.
These requirements do not apply when building from a distribution tarball.
See also HACKING for more detailed coreutils contribution guidlines.

* 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.
Specific tools and versions will be checked for and listed by the
bootstrap script shown below, and will include:

- 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/>
- Git <http://git.or.cz/>
- Gperf <http://www.gnu.org/software/gperf/>
- Gzip <http://www.gnu.org/software/gzip/>
- Perl <http://www.cpan.org/>
- Rsync <http://samba.anu.edu.au/rsync/>
- Tar <http://www.gnu.org/software/tar/>

Only building the initial full source tree will be a bit painful.
Later, a plain `git pull && make' should be sufficient.

- Valgrind

Valgrind <http://valgrind.org/> is also highly recommended, if
Valgrind supports your architecture. See also README-valgrind.

- XZ utils (successor to LZMA)

This package's build procedure uses XZ to create a compressed
distribution tarball.  Using this feature of Automake requires
version 1.10a or newer, as well as the xz program itself.
Make sure you have the latest version of the XZ Utils from
<http://tukaani.org/lzma/download>.

* First GIT checkout

You can get a copy of the source repository like this:

        $ git clone git://git.sv.gnu.org/coreutils
        $ cd coreutils

The next step is to get and check other files needed to build,
which are extracted from other source packages:

        $ ./bootstrap

And there you are!  Just

        $ ./configure #[--enable-gcc-warnings]
        $ 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-2009 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 3 of the License, 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, see <http://www.gnu.org/licenses/>.

Local Variables:
indent-tabs-mode: nil
End: