Making a README.md and scouring the internet for advice? Yup. I’ve been there. Here are all the things I wished were just in one place for me to look at when I was first starting out.
A single pound sign (yes! I’m calling it a pound sign) + SPACE + Your Heading will create the largest title github has on tap. I forgot the add the space in between the # and the heading and it drove me crazy for about 15 minutes. Add a # to decrease the size.
The Table of Contents
There are a lot of different headings you can put in a table of contents. This is by no means an exhaustive list but are a few of the options you can serve up. To make bullet points use the * symbol followed by [text you want to link](#heading of where you want it linked)
* [General Info](#general-info)
* [Code Examples](#code-examples) — Use ``` before and after your code to make it look pretty
* [Contact](#contact) — Use [email me](mailto:firstname.lastname@example.org)
There’s a lot of ways you can skin this cat. Some people like to create a .gif on giphy.com while others like to just import the link to the video right into their readme. It’s entirely up to you. I personally really like Vimeo’s screen recorder so I use that and then convert the file to whatever I want via Cloud Convert.
This one is very simple. Just type “:” and then the word of whatever kind of emoji you’d like to use. Here’s a whole list of them if you’re interested.