We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
scripts
1 parent 7788f13 commit b9e3dc0Copy full SHA for b9e3dc0
scripts/readme.md
@@ -0,0 +1,22 @@
1
+
2
+# README Generator Script
3
4
+This `generate-readme.sh` script updates `README.md` by generating a Table of Contents (ToC) from all Markdown files in the repository.
5
+It replaces the `[table_of_contents]` placeholder in `README.template.md` with the generated index.
6
7
+## Usage
8
9
+```bash
10
+./scripts/generate-readme.sh [option]
11
+```
12
13
+Options:
14
15
+* `--check` : verify if `README.md` is up to date (exit 1 if not).
16
+* `--bless` : regenerate and overwrite `README.md`.
17
18
+## Notes
19
20
+* `README.template.md` must contain `[table_of_contents]`.
21
+* Run `--check` before committing to ensure the ToC is current.
22
0 commit comments