X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=README;h=a809b775b632fb2632376dc93e6d9526a161d859;hb=b5b76263bbf5d51c11dbe839fdbf8f5d1869a350;hp=f516916689457f3a3c858ff5fb44c839689770b5;hpb=604f251f6c1ba5c71c7e03d9007dccd8e01eb64e;p=template.git diff --git a/README b/README index f516916..a809b77 100644 --- 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= to `make install', will be + prefixed to all installation directories. This might be useful when creating + packages for foobar. + +Author +------ + + Sebastian "tokkee" Harl