Create a README.md file to use for your projects and make them stand out in GitHub, etc.
I was taking a course about React from Udemy. You may know that there are specific projects you have to submit for review and pass to graduate. In my reviews, there was a section about README file format with links provided for further reading.
I usually pay attention not to leave my code uncommented where it is necessary or write some documentation for the scenarios or business flows in a project, etc. but I clearly saw that I should do it in a specific template with certain titles.
This is the free Udacity course for Writing READMEs:
This is the cheatsheet you can use to look up how to format your README content:
Here is the emoji cheatsheet if you want to use them in your READMEs.
https://www.makeareadme.com/ has a “Template” section where you can see these mark up examples. On the left side, you see content in raw format and on the right side, you can see the output.
You can also edit and test with https://dillinger.io/. There are options on the upper right menu to save directly to Github, Medium, etc or import in.
I created a README.md file to use as a template for my projects (you can check it out here and view its raw state):
Happy Coding!
