Code

README: Added section "Configuring / Compiling / Installing".
[template.git] / README
1 foobar
2 ======
4   This is a template for small projects. Replace all occurrences of "foobar"
5   with the name of the project...
7 Prerequisites
8 -------------
10   To compile the foobar package from source you need:
12   * A build environment: autotools, libtool, C compiler, ...
14   * A POSIX + Single UNIX Specification compatible C library.
16 Configuring / Compiling / Installing
17 ------------------------------------
19   To configure, build and install foobar with the default settings, run
20   `./configure && make && make install'. For detailed, generic instructions
21   see INSTALL. For a complete list of configure options and their description,
22   run `./configure --help'.
24   By default, foobar will be installed into `/opt/foobar'. You can adjust this
25   setting by specifying the `--prefix' configure option - see INSTALL for
26   details. If you pass DESTDIR=<path> to `make install', <path> will be
27   prefixed to all installation directories. This might be useful when creating
28   packages for foobar.
30 Author
31 ------
33   Sebastian "tokkee" Harl <sh@tokkee.org>