This is my template for the README files. The files are in Markdown format; even in the situations, where other formats deem more popular (like reSt in the Python world)
# <PROJECT_NAME>
<SHORT_DESCRIPTION>. <FURTHER_DESCRIPTION>
<INSTALLATION_AND_OR_USAGE_INSTRUCTIONS>
## Licence
Copyright © <YEAR> [Nikita Karamov]\
Licensed under [<FULL_LICENCE_NAME>].
---
This project is hosted on <FORGE_NAME>:
<<GIT_HTTPS_CLONE_URL>>
[<FULL_LICENCE_NAME>]: <LINK_TO_LICENCE_ON_SPDX>
[Nikita Karamov]: https://www.kytta.dev
<OTHER_LINKS>Example
This is a README of an archived project con-math:
# con-math
Solutions to (some) Concrete Mathematics problems, given in Concrete Mathematics
course at HS ITIS, KFU.
All (or most) of the solutions are written in Go since it outperforms Java and
Python and it's friendlier than C/C++ or Rust.
## Licence
Copyright © 2019 [Nikita Karamov]\
Licensed under the [BSD Zero Clause License].
---
This project is hosted on Codeberg:
<https://codeberg.org/kytta/con-math.git>
[BSD Zero Clause License]: https://spdx.org/licenses/0BSD.html
[Nikita Karamov]: https://www.kytta.dev/