Skip to content

README: add table of contents #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bhcopeland merged 1 commit into from
Jan 14, 2026
+9 −4
Merged

README: add table of contents #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 1 addition & 4 deletions scripts/readme2index.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}" $@