How To Create Beautiful and Useful ReadMe Documents For GitHub

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/awesome-readme
• 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-sheet/
• Markdown Cheatsheet: https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf

Markdown Editors:

• Dillinger.io: https://dillinger.io
• Editor.md: https://pandao.github.io/editor.md/en.html
• 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/electron-markdownify
• Clairvoyant: https://github.com/anfederico/clairvoyant
• Colorls: https://github.com/athityakumar/colorls

Socials:

• YouTube: https://www.youtube.com/channel/UCs_a2ClztgYY-hHYI-Qzz8g
• Medium: https://medium.com/@mrrandomgenerator
• Twitter: https://twitter.com/MrRandomGen

You can support the channel by using the affiliate links below, I highly appreciate that. CS Books That I Highly Recommend

• Clean Code : https://amzn.to/3mxydpT
• The Pragmatic Programmer : https://amzn.to/3mEAxeQ
• Head First Design Patterns : https://amzn.to/2JkhnMT
• Code : https://amzn.to/3mxpt32
• Cracking The Coding Interview : https://amzn.to/39A7LYR

Things I Use or Recommend

• Keyboard : https://amzn.to/3fYtScO
• Headphone : https://amzn.to/39CEPzw
• Mouse : https://amzn.to/3lEOQyI
• Microphone : https://amzn.to/2Vvw1Dq
• Gamepad : https://amzn.to/36xrIxH
• Desk Lamp : https://amzn.to/3ohjvDH

#Readme #Github #Markdown

Music Used –––––––––––––––––––––––––––––– Bettogh - Another World: https://soundcloud.com/bettogh/bettogh-another-world Bettogh Soundcloud: https://soundcloud.com/bettogh Bettogh Youtube: https://www.youtube.com/channel/UCaE0dg0_-RFYOXMdgWG4ocg

Metaphazic - Slipstream: https://soundcloud.com/metaphazic/slipstream Metaphazic Soundcloud: https://soundcloud.com/metaphazic Metaphazic Youtube: https://www.youtube.com/channel/UChNlZfKek0TCKpiwEvz5bxQ ... https://www.youtube.com/watch?v=a8CwpGARAsQ