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.05metadata:6 source: https://skillmd.com/skills/myl7/readme7 author: Yulong Ming <i@myl7.org>8---910## Template1112```md13# Project Name14<!-- If we have a descriptive one, use it. Otherwise, use the project dirname, project-name. -->1516[][...]1718One-line description that catches project's highlights19<!-- Say what the project can do (functionality), not how to do (methods).20**No period** if there is only one sentence. Add periods if there are multiple ones.21Texts can be hyperlinked. -->2223[Documentation](...)24<!-- If there are external links, e.g., external documentations at docs.rs or github.io, put them here. -->2526## Features2728- **Feature**: Feature description. Do not include technical details.29- ...30- ...3132## Prerequisites3334List required dependencies, runtime, or systems.35Include versions if required.3637## Get Started3839Step-by-step instructions to run project, including installation, configuration, and usage.4041## Config4243List and explain configuration options.4445## Other sections that are useful for users4647...4849## License50<!-- Always singular -->5152Copyright (C) year Holder Name <email> **No period**53<!-- Try reading from ~/.gitconfig. -->5455License Name (e.g., Apache License, Version 2.0) **No period**56<!-- Read LICENSE/LICENSE.*, or fallback to the license field of the package manifest (e.g., package.json, Cargo.toml, pyproject.toml, etc.). -->57```5859- If a section cannot be provided, e.g., the project has no badges, configuration, or prerequisites, Omit the section but report the action.60- Report any action that violates the template.6162## Style6364- Readme is for users. Do not include technical details or framework information unless requested.65- Write in English by default.66- If there exists an old readme that does follow the template, extract information from it and generate the new readme from scratch.