aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2018-05-18 16:41:36 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2018-05-18 16:41:36 +0200
commit8e07eb474891662bee0a6d0bd4116c2371d41e7e (patch)
tree3f61d9a10f5fe18c7fb89ebf62c6081ba4ec3de0 /doc
parent509b121d12e8318e2395622edbd84fa458ef5b6b (diff)
Update documentation with new install procedure
Diffstat (limited to 'doc')
-rw-r--r--doc/install.cli12
-rw-r--r--doc/intro.cli3
2 files changed, 13 insertions, 2 deletions
diff --git a/doc/install.cli b/doc/install.cli
index 4885e24..4d241f4 100644
--- a/doc/install.cli
+++ b/doc/install.cli
@@ -12,6 +12,18 @@
//
"
+\h0#preface|Preface|
+
+The recommended way to install the \c{build2} toolchain in most circumstances
+is using the automated install scripts as described on the
+\l{https://build2.org/install.xhtml Install} page. This document describes the
+manual installation and upgrade process which offers greater control can be
+helpful in situations where the automated scripts cannot be used (offline
+installation, packaging for system package managers, unsupported
+platform/compiler, etc).
+"
+
+"
\h#INSTALL|Introduction|
"
source "../INSTALL.cli";
diff --git a/doc/intro.cli b/doc/intro.cli
index df62eaf..3487305 100644
--- a/doc/intro.cli
+++ b/doc/intro.cli
@@ -98,8 +98,7 @@ command output so if you just want to get a sense of what \c{build2} is about,
then you don't have to install the toolchain and run the commands in order to
follow along. If at the end you find \c{build2} appealing and would like to
start using it or try the examples for yourself, you can jump straight to
-\l{build2-toolchain-install.xhtml The \c{build2} Toolchain Installation and
-Upgrade}.
+the \l{https://build2.org/install.xhtml Install} page.
One of the primary goals of the \c{build2} toolchain is to provide a uniform
interface across all the platforms and compilers. While the examples in this