Last active
December 18, 2019 18:09
-
-
Save alexstolr/8de1d5e525b598c038f5627be5f8cb50 to your computer and use it in GitHub Desktop.
Writing a readme.md file
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| https://learn-the-web.algonquindesign.ca/topics/writing-a-readme/ | |
| Basic writing: https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax#links | |
| https://help.github.com/en/github/administering-a-repository/classifying-your-repository-with-topics | |
| how to add buttons: https://shields.io/ | |
| topics: https://help.github.com/en/github/administering-a-repository/classifying-your-repository-with-topics | |
| emojis: | |
| https://gist.github.com/rxaviers/7360908 | |
| https://gist.github.com/roachhd/1f029bd4b50b8a524f3c | |
| line breaks: https://gist.github.com/shaunlebron/746476e6e7a4d698b373 | |
| images in a readme: https://stackoverflow.com/questions/14494747/add-images-to-readme-md-on-github | |
| markdown: https://guides.github.com/features/mastering-markdown/ | |
| guides: | |
| https://github.com/matiassingers/awesome-readme | |
| https://linux-audit.com/how-to-promote-your-open-source-project/ | |
| must have: code coverage, tests, documentation |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment