Commit d3e5c7b8 authored by Dom Sekotill's avatar Dom Sekotill
Browse files

Added README.developers w/ initialisation instructions

parent 8754ad54
Loading
Loading
Loading
Loading

README.developers

0 → 100644
+45 −0
Original line number Diff line number Diff line
    Initialising Source from Git Repository
    =======================================

This code uses `autoconf' and `automake' to generate the configure and
Makefile.in files needed to build the project. When the code is
distributed in tarballs these files are included and users only need
to run the standard `configure; make; make install' commands. For
users and developers who got the code from a git repository the
`autoconf' & `automake' tools will have to be used to initialise the
project. There are two ways of doing this, either by calling the tools
in the correct order or with the `autoreconf' tool, which hugely
simplifies the process.

  With `autoreconf'
  -----------------
For a first time initialisation the `autoreconf' tool needs to be run
with the `--install' argument to add a couple of necessary files.

    $ autoreconf --install

This only needs to be done once from a clean source directory. If any
changes are made to the autotools files the build files can be updated
with just

    $ autoreconf

  Without `autoreconf'
  --------------------
If the `autoreconf' command is not available if can be emulated with a
combination of several other commands. For the first time
initialisation the following commands need to be given in order:

    $ aclocal
    $ autoconf
    $ automake --add-missing

After any changes to configure.ac autoconf and automake need to be re-
run to pick up the changes

    $ autoconf
    $ automake

and after changes to any Makefile.am files automake has to be re-run

    $ automake