Github Profile README is a good way to introduce yourself; visitors can know more about you other than top repos & how much you code every day. I'm working on a list of everything that's helped me grow as a developer. I'm constantly updating this and adding new and better t.
Introduction
When I create a Github repo, I try to make sure it's readme has at least one of the following elements:
- An introduction (What's the project about?)
- Table of contents (List me all your readme, so I can skim it and see if I'm interested or is what I'm looking for)
- Some design love (A logo, icon, teaser or screen, README's with images look so much better.
Example
How to... make an introduction
No brainer, but make sure it's an introduction, the same way papers have an abstract. I usually go for the following syntax:
The first uses the '#' tag, followed by the blockquote '>' tag and finally an horizontal line to separate it. Use the < hr > tag (yeah, markdown supports it! I separated it here because Coderwall parses it).
How to... make a table of contents.
Example (works in coderwall too, test it!) -
Separate the topics your repo talks about with the '#' tag, and then use the following syntax to add your table of contents (if you are lazy like me, go to this Gist and copy the example):
(In Github, you don't need to put the a name tag. It parses the h1 tags with a hyphen, so if they are named the same as your table of contents, you don't need to do anything else. In other places cofCoderwallcof you need to force it with the empty A tag)
How to... add images to a README.
You may not be strange with the familiar of the '!' followed by the alt name property in brackets and then parenthesis with the link.
It's the same in Github, but in order to properly display it properly, you need the RAW file. Create an assets folder, add your images there and use the RAW path in your project. You can even use other Github repo's images as long as they are Publics!
That's all folks. Any other Github beautiful tips?
Related protips:
I'm working on a list of everything that's helped me grow as a developer. I'm constantly updating this and adding new and better tools. Subscribe to my email list to get notified of any new changes.
VS Code
https://github.com/viatsko/awesome-vscode#readmeThis editor has become the most popular among developers. It has a great community and healthy plugin ecosystem.
Vim
https://github.com/mhinz/vim-galore#readmeThis is my editor of choice, but it's not the easiest to learn. You use shortcuts for everything which makes it fast and easy to perform actions, without taking a hand off of your keyboard. I find that this helps me stay in a flow state and be more productive.
Awesome Github Readme Templates
Bash - programming guide https://tldp.org/HOWTO/Bash-Prog-Intro-HOWTO.html#toc
Advanced Bash - https://www.tldp.org/LDP/abs/html/
Bash guide - https://github.com/Idnan/bash-guide
Bash hacker wiki - https://wiki.bash-hackers.org/
Other Shells
zsh - https://www.zsh.org
fish - https://fishshell.com
Awesome Shell List https://github.com/alebcay/awesome-shell#readme
Awesome Github Readme
Learn the basics of the command line here.
ag - Super fast string search through a directory hierarchy
aliases - Contextual, dynamic, organized aliases for bash
tmux - Amazing terminal multiplexer
Free book - https://github.com/jlevy/the-art-of-command-line
There are tons of free resources available, books, courses, pretty much everything you'll need.https://github.com/EbookFoundation/free-programming-books#readme
A list of all the things a developer could ever need to reference. There's a lot here, but I use this list often to find helpful and recommended tools.https://github.com/sindresorhus/awesome