How To Create Beautiful and Useful ReadMe Documents For GitHub

Опубликовано: 29 Сентябрь 2024
на канале: The Git Guild

89,828

2.2k

Creating a readme file sounds easy, and that is usually the case. However, creating a good, useful and on point readme file is rather challenging. So from that reason I decided to create this video as a simple guide about how to create one. So I hope you find it helpful. And if you want to add or correct something, feel free to do it in the comments down below.

Helpful Resources:
- Awesome ReadMe: https://github.com/matiassingers/awes...
- Banner Maker: https://banner.godori.dev
- Shields.io: http://shields.io
- Carbon: https://carbon.now.sh

Cheat Sheets:
- Markdown Guide: https://www.markdownguide.org/cheat-s...
- Markdown Cheatsheet: https://guides.github.com/pdfs/markdo...

Markdown Editors:
- Dillinger.io: https://dillinger.io
- Editor.md: https://pandao.github.io/editor.md/en...
- Make A Readme: https://www.makeareadme.com

Mentioned Projects:
- Joe: https://github.com/karan/joe
- Stronghold: https://github.com/alichtman/stronghold
- Markdownify: https://github.com/amitmerchant1990/e...
- Clairvoyant: https://github.com/anfederico/clairvo...
- Colorls: https://github.com/athityakumar/colorls

Socials:
- YouTube:    / @thegitguild
- Medium:   / mrrandomgenerator
- Twitter:   / mrrandomgen

#Readme #Github #Markdown

Music Used
––––––––––––––––––––––––––––––
Bettogh - Another World:   / bettogh-another-world
Bettogh Soundcloud:   / bettogh
Bettogh Youtube:    / @bettoghofficial

Metaphazic - Slipstream:   / slipstream
Metaphazic Soundcloud:   / metaphazic
Metaphazic Youtube:    / @metaphazic