amchagas
commented
4 years ago i should also note that the .md extension stands for Markdown, which is a "language" that is understood both by humans and computers here is a more extensive explanation https://www.markdownguide.org/getting-started
the Readme.md file at the root of the GH repo gets rendered automatically, so it is a nice place to make a small overview of the project, adding images, links and contact information.
One can also add information about hwo the entire repository is structured.
Here are some examples: https://github.com/eulerlab/open-visual-stimulator/ https://github.com/BadenLab/LED-Zappelin https://github.com/vektorious/lightM