version-gen.sh: Prepend a dot to VERSION_EXTRA.

[template.git] / README

diff --git a/README b/README
index f516916689457f3a3c858ff5fb44c839689770b5..a809b775b632fb2632376dc93e6d9526a161d859 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,40 @@
 foobar
 ======
 
-This is a template for small projects. Replace all occurrences of "foobar"
-with the name of the project...
+  This is a template for small projects. Replace all occurrences of "foobar"
+  with the name of the project...
+
+  This is free and open source software, licensed under the
+  GNU General Public License, version 2
+OR:
+  2-clause BSD license.
+  See COPYING for details.
+
+Prerequisites
+-------------
+
+  To compile the foobar package from source you need:
+
+  * A build environment: autotools, libtool, C compiler, ...
+
+  * A POSIX + Single UNIX Specification compatible C library.
+
+Configuring / Compiling / Installing
+------------------------------------
+
+  To configure, build and install foobar with the default settings, run
+  `./configure && make && make install'. For detailed, generic instructions
+  see INSTALL. For a complete list of configure options and their description,
+  run `./configure --help'.
+
+  By default, foobar will be installed into `/opt/foobar'. You can adjust this
+  setting by specifying the `--prefix' configure option - see INSTALL for
+  details. If you pass DESTDIR=<path> to `make install', <path> will be
+  prefixed to all installation directories. This might be useful when creating
+  packages for foobar.
+
+Author
+------
+
+  Sebastian "tokkee" Harl <sh@tokkee.org>