aboutsummaryrefslogtreecommitdiff
path: root/README-hacking
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2016-08-30 16:59:59 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2016-08-30 17:33:20 +0300
commita471e9e23a5362fbcf2c3e3f7353867c25809e40 (patch)
treebe59fbfbdf77fa61ecfcb310ce21e0a428835062 /README-hacking
parentfb3b7f3f8e199363b4131d62d4b66eb74eca6e5f (diff)
downloadrex-a471e9e23a5362fbcf2c3e3f7353867c25809e40.tar.gz
rex-a471e9e23a5362fbcf2c3e3f7353867c25809e40.tar.bz2
Improve bootstrapping and documentation.
* GNUmakefile: Typing `make' without arguments bootstraps, configures and builds the package. (help) New goal. * Makefile.am: Use AWK variable, instead of hardcoded name of the awk binary. * README: New file. * README-hacking: New file.
Diffstat (limited to 'README-hacking')
-rw-r--r--README-hacking43
1 files changed, 43 insertions, 0 deletions
diff --git a/README-hacking b/README-hacking
new file mode 100644
index 0000000..548036c
--- /dev/null
+++ b/README-hacking
@@ -0,0 +1,43 @@
+* Overview
+
+This file provides instructions on how to bootstrap rex sources obtained
+from Git repository.
+
+For generic information about Rex and its purposes, please see the file
+README.
+
+* Prerequisites
+
+In order to bootstrap rex from git sources you will need the following tools:
+
+- Automake <http://www.gnu.org/software/automake/>
+- Autoconf <http://www.gnu.org/software/autoconf/>
+- Make <http://www.gnu.org/software/make/>
+- AWK <http://www.gnu.org/software/gawk/>
+
+* Bootstrapping and Building
+
+Provided that the prerequisites are satisfied, typing
+
+ make
+
+will bootstrap, configure and build the package using the default
+configuration.
+
+If GNU awk is available under a different name or in another directory,
+use the AWK variable to indicate it, e.g.: make AWK=gawk.
+
+* Make commands
+
+ make bootstrap Create the configure script and auxiliary files.
+ make conf Create the configure script and run it.
+ make help Displays this document.
+
+Right after checkout, the commands
+
+ make
+or
+ make all
+
+are equivalent to "make conf" followed by "make".
+

Return to:

Send suggestions and report system problems to the System administrator.