Require rainbow README section divider
This commit is contained in:
@@ -114,9 +114,12 @@ If using the generator:
|
||||
|
||||
1. Fill `blueprint.md`.
|
||||
2. Fill `blueprint.json`.
|
||||
3. Add a `readme` command.
|
||||
4. Generate `README.md`.
|
||||
5. Commit `README.md`, `blueprint.md`, and `blueprint.json`.
|
||||
3. Keep `{{ template:section-line }}` between major README sections.
|
||||
4. Add a `readme` command.
|
||||
5. Generate `README.md`.
|
||||
6. Commit `README.md`, `blueprint.md`, and `blueprint.json`.
|
||||
|
||||
The default section divider is the rainbow line from `andreasbm/readme`, configured in `blueprint.json` as `section-line`. Agents should keep it enabled for generated README files.
|
||||
|
||||
If not using the generator, keep a manual README with the same main sections:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user