From 55e705b255596ccdce5c4750aebd16a6f705600d Mon Sep 17 00:00:00 2001
From: Anders Roxell <anders.roxell@linaro.org>
Date: Wed, 14 Jan 2026 12:29:03 +0100
Subject: [PATCH] README: add table of contents

After 512ef51446da ("Update README.md to reference GitHub instead of GitLab")
the GitLab-specific [[_TOC_]] was removed, so lets add a manual table of
contents that works on GitHub. Also remove the now unnecessary /_TOC_/d
sed pattern from readme2index.sh.

Signed-off-by: Anders Roxell <anders.roxell@linaro.org>
---
 README.md               | 8 ++++++++
 scripts/readme2index.sh | 5 +----
 2 files changed, 9 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 1a3f88f1..a4d97d23 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,14 @@ testing Linux on the following virtual devices, using curated test suites.
 TuxRun is a part of [TuxSuite](https://tuxsuite.com), a suite of tools and
 services to help with Linux kernel development.
 
+## Table of Contents
+- [About TuxRun](#about-tuxrun)
+- [Installing TuxRun](#installing-tuxrun)
+- [Using TuxRun](#using-tuxrun)
+- [TuxLAVA Library](#tuxlava-library)
+- [Known issues](#known-issues)
+- [Examples](#examples)
+
 # About TuxRun
 
 Testing the Linux kernel is as simple as using QEMU but it gets complicated
diff --git a/scripts/readme2index.sh b/scripts/readme2index.sh
index 17c3eda6..088f2a60 100755
--- a/scripts/readme2index.sh
+++ b/scripts/readme2index.sh
@@ -6,8 +6,5 @@ tmpfile=$(mktemp)
 trap 'rm -f $tmpfile' INT TERM EXIT
 
 cp README.md "${tmpfile}"
-sed -i -e '
-/_TOC_/d
-s#docs/##
-' "${tmpfile}"
+sed -i -e 's#docs/##' "${tmpfile}"
 cp "${tmpfile}" $@