A readme template repository
Yeah, this is what you just read: "a readme-template repository". In this, i'll keep a padronization of all my project's readmes.
Feel free to copy them and modify for your own purposes
Here you will find the following templates:
-
In construction - For those repos that doesn't have notthing yet
-
All-in-one - The readme for monorepos
-
Mobile - A template for mobile apps
-
Server - For APIs and stuff
-
Web - To be used in frontend aplicattions
Okay.. But "why a multi-languaged readme"?, you may ask.
Well.. if you're still here, let me tell ya a story:
Even in the beggining of my journey doing READMEs, I was uncomfortable with this question. Well.. I live in Brazil and, even though some of us can comunicate in English very easilly, there is a huge percentage of us that can't.
Still, when making this question above, i've always got the same answer, almost instantly:
"YOU SHOULD ALWAYS WRITE READMEs IN ENGLISH, SO EVERYONE WILL UNDERSTAND".
-- Comunity
As you can see, I wasn't convinced.
So, the only way was to do.. both.
Considering github does not have any functionallity known by me (until this moment) as a "multi language support" or anything like that, I decided to use in this repo a known workaround that links another README file with the desired language.
If you notice, there is a "button" on the left-top of this file, like this:
# you can do that this way:
[](./README.pt.md)
# or using an img tag in HTML
<a href="./README.pt.md">
<img src="./.github/lg-button-pt.png" alt="pt-br" width="180px" ></img>
</a>
I've put this on every README file, which leads you to a "README.< abreviation-of-choosen-language >.md" (in this case, brasilian portuguese)
Simple as that.
If you liked this repository and would like to contribute, just open a pull request and i'll happilly review it 🤍
And if you have any suggestion, just let me know :)
Let's talk