diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 281fd7f..fcb08bd 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -47,3 +47,10 @@ repos: hooks: - id: codespell args: ["-L", "ans"] + + - repo: https://github.com/jsh9/markdown-toc-creator + rev: "b7b53d559b569730c4ebca86e9ab1a9d796a2214" # frozen: v0.0.8 + hooks: + - id: markdown-toc-creator + files: README.md + args: ["--skip-first-n-lines=4"] diff --git a/README.md b/README.md index dc598f6..64a49fa 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,28 @@ When many of the build and installation commands changed, it made sense to abstr _Note:_ We now have experimental builds for editable installs. Most of the Meson commands listed below should work "out of the box" for those. + + +- [Installation](#installation) +- [Configuration](#configuration) + - [Command sections](#command-sections) +- [Running](#running) +- [Built-in commands](#built-in-commands) + - [Meson](#meson) + - [Build (PEP 517 builder)](#build-pep-517-builder) + - [pip (Package Installer for Python)](#pip-package-installer-for-python) + - [Meta (commands that operate on commands)](#meta-commands-that-operate-on-commands) +- [🧪 Custom commands](#-custom-commands) + - [Configuration](#configuration-1) + - [Argument overrides](#argument-overrides) + - [Advanced: adding arguments to built-in commands](#advanced-adding-arguments-to-built-in-commands) + - [Advanced: override Meson CLI](#advanced-override-meson-cli) +- [FAQ](#faq) +- [For contributors](#for-contributors) +- [History](#history) + + + ## Installation ```