From 1cbc283f94aab45ca1246d248f4d323b5f455221 Mon Sep 17 00:00:00 2001
From: Rob Landley
Date: Wed, 28 Oct 2015 21:41:45 -0500
Subject: Tweak build instructions in README/code.html.
---
README | 21 +++++++++++++++++----
www/code.html | 9 +++++++--
2 files changed, 24 insertions(+), 6 deletions(-)
diff --git a/README b/README
index 9ff73681..5a4a2cac 100644
--- a/README
+++ b/README
@@ -18,13 +18,23 @@ specifying a path to it, so this should work:
Type "make help" for build instructions.
-Usually you want something like:
+Toybox uses the "make menuconfig; make; make install" idiom same as
+the Linux kernel. Usually you want something like:
make defconfig
- LDFLAGS="--static" CROSS_COMPILE=armv5l- make toybox
- PREFIX=/path/to/root/filesystem make install
+ make
+ make install
-The CROSS_COMPILE argument is optional, and without it builds a version of
+Or maybe:
+
+ LDFLAGS="--static" CROSS_COMPILE=armv5l- make defconfig toybox
+ PREFIX=/path/to/root/filesystem/bin make install_flat
+
+The file "configure" defines default values for many environment
+variables that control the toybox build; if you set a value for any of
+these, your value is used instead of the default in that file.
+
+The CROSS_COMPILE argument above is optional, the default builds a version of
toybox to run on the current machine. Cross compiling requires an appropriately
prefixed cross compiler toolchain, several example toolchains are available at:
@@ -40,6 +50,9 @@ For more about cross compiling, see:
http://landley.net/writing/docs/cross-compiling.html
http://landley.net/aboriginal/architectures.html
+For a more thorough description of the toybox build process, see
+http://landley.net/toybox/code.html#building
+
--- Using toybox
The toybox build produces a multicall binary, a "swiss-army-knife" program
diff --git a/www/code.html b/www/code.html
index 6050aa1a..b1c6d3f9 100644
--- a/www/code.html
+++ b/www/code.html
@@ -30,6 +30,10 @@ controls which features are included when compiling toybox.
either isn't complete or is a special-purpose option (such as debugging
code) that isn't intended for general purpose use.
+For a more compact human-editable version .config files, you can use the
+miniconfig
+format.
+
The standard build invocation is:
@@ -47,8 +51,9 @@ accepts existing definitions of the environment variables, so it may be sourced
or modified by the developer before building and the definitions exported
to the environment will take precedence.
-(To clarify: "configure" describes the build and installation environment,
-".config" lists the features selected by defconfig/menuconfig.)
+(To clarify: ".config" lists the features selected by defconfig/menuconfig,
+I.E. "what to build", and "configure" describes the build and installation
+environment, I.E. "how to build it".)
--
cgit v1.2.3