Matthias Ott

A while ago, I wrote a little about what to include in a README for a project (https://matthiasott.com/notes/how-to-readme).

I now also created and published a README template I’ll use in upcoming projects. I hope it is useful! Any contributions or corrections are very welcome. 🤗

https://github.com/matthiasott/README-template

How To README · Matthias Ott – User Experience Designer

Matthias Ott is an independent user experience designer and developer from Stuttgart, Germany. Besides design practice he teaches Interface Prototyping at the Muthesius Academy of Fine Arts and Design, Kiel.

Matthias Ott – User Experience Designer
Apr 11, 2023 at 11:05amWeb
Show threadMatthias OttApr 11, 2023
BTW, I automatically generated the table of contents for the README with doctoc: https://github.com/thlorenz/doctoc
Will write a short post about it after lunch. 🍜
GitHub - thlorenz/doctoc: 📜 Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github or other sites.

📜 Generates table of contents for markdown files inside local git repository. Links are compatible with anchors generated by github or other sites. - GitHub - thlorenz/doctoc: 📜 Generates table of ...

GitHub
Show threadMatthias OttApr 11, 2023
✍️ Post: https://matthiasott.com/notes/a-readme-template-with-an-automatically-generated-table-of-contents
A README Template – With an Automatically Generated Table of Contents · Matthias Ott – User Experience Designer

Matthias Ott is an independent user experience designer and developer from Stuttgart, Germany. Besides design practice he teaches Interface Prototyping at the Muthesius Academy of Fine Arts and Design, Kiel.

Matthias Ott – User Experience Designer
Show threadwhite_geckoApr 11, 2023
@matthiasott
I think it is a good idea to keep the changelog in a separate file following https://keepachangelog.com/en/1.1.0/
Keep a Changelog

Don’t let your friends dump git logs into changelogs.

Show threadMatthias OttApr 11, 2023
@white_gecko Interesting, thank you! I’ll have a look… 😁
Show threadJakob VoßApr 11, 2023
@matthiasott @white_gecko We use https://github.com/RichardLitt/standard-readme/blob/main/spec.md but any README template is better than not following any consistent style
standard-readme/spec.md at main · RichardLitt/standard-readme

A standard style for README files. Contribute to RichardLitt/standard-readme development by creating an account on GitHub.

GitHub