Readme

Template

# Project Name
<!-- If we have a descriptive one, use it. Otherwise, use the project dirname, project-name. -->

[![Badges](...)][...]

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