Template
# Project Name
<!-- If we have a descriptive one, use it. Otherwise, use the project dirname, project-name. -->
[][...]
One-line description that catches project's highlights
<!-- Say what the project can do (functionality), not how to do (methods).
**No period** if there is only one sentence. Add periods if there are multiple ones.
Texts can be hyperlinked. -->
[Documentation](...)
<!-- If there are external links, e.g., external documentations at docs.rs or github.io, put them here. -->
## Features
- **Feature**: Feature description. Do not include technical details.
- ...
- ...
## Prerequisites
List required dependencies, runtime, or systems.
Include versions if required.
## Get Started
Step-by-step instructions to run project, including installation, configuration, and usage.
## Config
List and explain configuration options.
## Other sections that are useful for users
...
## License
<!-- Always singular -->
Copyright (C) year Holder Name <email> **No period**
<!-- Try reading from ~/.gitconfig. -->
License Name (e.g., Apache License, Version 2.0) **No period**
<!-- Read LICENSE/LICENSE.*, or fallback to the license field of the package manifest (e.g., package.json, Cargo.toml, pyproject.toml, etc.). -->
- If a section cannot be provided, e.g., the project has no badges, configuration, or prerequisites, Omit the section but report the action.
- Report any action that violates the template.
Style
- Readme is for users. Do not include technical details or framework information unless requested.
- Write in English by default.
- If there exists an old readme that does follow the template, extract information from it and generate the new readme from scratch.
1---2name: readme3description: Use when creating or updating the readme (README.md).4license: Apache-2.05---67## Template89```md10# Project Name11<!-- If we have a descriptive one, use it. Otherwise, use the project dirname, project-name. -->1213[][...]1415One-line description that catches project's highlights16<!-- Say what the project can do (functionality), not how to do (methods).17**No period** if there is only one sentence. Add periods if there are multiple ones.18Texts can be hyperlinked. -->1920[Documentation](...)21<!-- If there are external links, e.g., external documentations at docs.rs or github.io, put them here. -->2223## Features2425- **Feature**: Feature description. Do not include technical details.26- ...27- ...2829## Prerequisites3031List required dependencies, runtime, or systems.32Include versions if required.3334## Get Started3536Step-by-step instructions to run project, including installation, configuration, and usage.3738## Config3940List and explain configuration options.4142## Other sections that are useful for users4344...4546## License47<!-- Always singular -->4849Copyright (C) year Holder Name <email> **No period**50<!-- Try reading from ~/.gitconfig. -->5152License Name (e.g., Apache License, Version 2.0) **No period**53<!-- Read LICENSE/LICENSE.*, or fallback to the license field of the package manifest (e.g., package.json, Cargo.toml, pyproject.toml, etc.). -->54```5556- If a section cannot be provided, e.g., the project has no badges, configuration, or prerequisites, Omit the section but report the action.57- Report any action that violates the template.5859## Style6061- Readme is for users. Do not include technical details or framework information unless requested.62- Write in English by default.63- If there exists an old readme that does follow the template, extract information from it and generate the new readme from scratch.
myl7