DEV Community

Cover image for Next Level Github Readme
Louis
Louis

Posted on

Next Level Github Readme

The readme file is often the first thing people see when they look at a repository. So it is important for the first impression. If the readme file is not present at all, people usually assume that the project is not really good. Also, people usually don't know how to use the project or what it even does.

Especially with resume projects, a good and detailed readme should always be there! 🚀

To fight this problem, I created this readme template for myself and would like to share it with you.
It is available as a template and so easy to use for your next project.

Use Template button

Please note that this template is very detailed and might be too extensive for some projects, so you might want to delete some sections.

https://github.com/Louis3797/awesome-readme-template

Table of Content

Features

  • Logo
  • Badges from shields.io
  • Emojis
  • Contributor Images

https://github.com/Louis3797/awesome-readme-template

Feel free to use this in your projects and I hope this readme is helpful for some of you 😄.

Top comments (0)