README available in:

It is undeniable that documentation is a valid part of a good project. It helps others who might be interessed but also the ones who contribute adding more clarity and structure.

There are so many great README over the internet let alone GitHub. However, I decided to create my onw custom template so that I can kickstart my project easily with my standards.

For this README template creation, there is no really specific technology except Markdown.

It's pretty simple to use it. Just clone the repo and it's all yours !!!

You can use the file README-BLANK.md to get started. It has the minimal structure to start a project. By default, it is written in English.

No specific requirements.

This README is an example of what my template can create.

• Add Emoji
• Add back to top links
• Add relevant gifs for this README
• Multi-language Support
  • French
  • English

• For now, the README is not too specific.

Thanks in advance for anyone who will contribute to expanding this template!

😱 Found a bug? Missing a specific feature?

If you have any suggestion, please proceed by forking this repo and creating a pull request or opening an issue with the tag enhancement.

🤩 Don't forget to give the project a star! Thanks again!

This project is released under the terms of the MIT License.

🏆 Here are the nominees, with no particular order, in the category for best resources used for this project:

• How to Add Badges to a GitHub Repository
• Choose an Open Source License
• Img Shields for those beautiful badges !
• HTML code generator for the flag
• SVG Repo for the icons used here aka the logo and the back to top icon.
• Awesome README: a curated list of awesome READMEs!
• Best-README-Template: another README template you can check it out.
• Fiber for their multilingual README.

Thanks again for reading this README !!!