Mike Gerwitz

Activist for User Freedom

aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMike Gerwitz <mike.gerwitz@rtspecialty.com>2019-01-29 16:43:18 -0500
committerMike Gerwitz <mike.gerwitz@rtspecialty.com>2019-01-30 13:44:43 -0500
commit0c67e85676b5cf1acefbfb63ceb8fb2c9428589d (patch)
tree585a08d24f985b79e5f9c189f1783279e4ce3a44 /doc
parent2e0a3fa62f24ed3d3e629545c48b39bd639ace37 (diff)
downloadtame-0c67e85676b5cf1acefbfb63ceb8fb2c9428589d.tar.gz
tame-0c67e85676b5cf1acefbfb63ceb8fb2c9428589d.tar.bz2
tame-0c67e85676b5cf1acefbfb63ceb8fb2c9428589d.zip
doc: Add cindex entries for existing About
* doc/about.texi: Add miscellaneous entries.
Diffstat (limited to 'doc')
-rw-r--r--doc/about.texi9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/about.texi b/doc/about.texi
index f4108f7..5de4747 100644
--- a/doc/about.texi
+++ b/doc/about.texi
@@ -54,6 +54,9 @@ The input grammar is XML,
@node Getting Started
@section Getting Started
+@cindex Saxon
+@cindex HOXSL
+@cindex bootstrap
To get started,
make sure Saxon version@tie{}9 or later is available and its path
set as @var{SAXON_CP};
@@ -74,10 +77,11 @@ $ ./boostrap
@node Manual Compilation
@section Manual Compilation
-@emph{Note: TAME is usually controlled through a Makefile;
+@tip{Note: TAME is usually controlled through a Makefile;
@pxref{Compiling With Make} to avoid manual compilation
steps.}
+@cindex tamed
@tame{} is controlled through the program in @command{bin/tame}.
When run,
it first spawns a daemon @command{bin/tamed} if it is not already
@@ -109,6 +113,7 @@ For additional options and environment variables that influence
@node Compiling With Make
@section Compiling With Make
+@cindex Make
TAME can generate a @url{https://gnu.org/software/make,GNU Makefile}
for you using @url{https://gnu.org/software/automake,Automake} and
@url{https://gnu.org/softeware/autoconf,Autoconf}.
@@ -117,6 +122,7 @@ This greatly simplifies building projects by automatically building
and only when they have changed.@footnote{@c
When their modification timestamps change, specifically.}
+@cindex Makefile
The Makefile is generated by a @file{configure} script,
which itself generated by Autoconf using @file{configure.ac} in the
project root:
@@ -132,6 +138,7 @@ m4_include([rater/build-aux/m4/calcdsl.m4])
@caption{Example @file{configure.ac} in project root.}
@end float
+@cindex submodule
By convention,
TAME is usually available as a submodule under @file{rater/}.
This confusing naming convention may change in the future.