README.md: Provide and run update-readme-toc

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

diff --git a/README.md b/README.md
index 3fe20abb5b6828be65233df5a8e7d52c812008b2..ce632da8e6367c570e9c4c7c7da406e47bf18b27 100644 (file)
--- a/README.md
+++ b/README.md
@@ -52,6 +52,31 @@ $ nailing-cargo build
 Documentation table of contents
 -------------------------------
 
+  * [Introduction](#nailing-cargo)
+    * [Installing](#installing)
+    * [Most basic example usage](#most-basic-example-usage)
+    * [Documentation table of contents](#documentation-table-of-contents)
+  * [Using local crates, or locally modified crates](#using-local-crates-or-locally-modified-crates)
+    * [How nailing-cargo helps with using local crates](#how-nailing-cargo-helps-with-using-local-crates)
+    * [Telling nailing-cargo how to massage `Cargo.toml`](#telling-nailing-cargo-how-to-massage-cargo.toml)
+  * [Out-of-tree builds](#out-of-tree-builds)
+    * [How nailing-cargo helps with out-of-tree builds](#how-nailing-cargo-helps-with-out-of-tree-builds)
+    * [Configuring out-of-tree builds](#configuring-out-of-tree-builds)
+  * [Target architecture convenience aliases](#target-architecture-convenience-aliases)
+  * [Default change to offline mode](#default-change-to-offline-mode)
+  * [Invocation and command-line option reference](#invocation-and-command-line-option-reference)
+    * [Usages](#usages)
+    * [Options](#options)
+    * [Environment of the build command](#environment-of-the-build-command)
+  * [Configuration reference](#configuration-reference)
+    * [Source directories and packages (toplevel)](#source-directories-and-packages-toplevel)
+    * [`[alt_cargolock]`: Alternative `Cargo.lock` filename](#alt_cargolock-alternative-cargo.lock-filename)
+    * [`[oot]`: Out-of-tree build support](#oot-out-of-tree-build-support)
+    * [`[arch]`: Architecture convenience aliases](#arch-architecture-convenience-aliases)
+    * [`[misc]`: Miscellaneous individual nailing-cargo config](#misc-miscellaneous-individual-nailing-cargo-config)
+  * [Limitations and bugs](#limitations-and-bugs)
+  * [Contributing and legal](#contributing-and-legal)
+    * [Legal](#legal)
 
 Using local crates, or locally modified crates
 ==============================================

diff --git a/update-readme-toc b/update-readme-toc
new file mode 100755 (executable)
index 0000000..793ffac
--- /dev/null
+++ b/update-readme-toc
@@ -0,0 +1,4 @@
+#!/bin/sh
+set -e
+./markdown-toc-filter <README.md >README.md.tmp
+mv -f README.md.tmp README.md