Personalize your README on GitHub

[This article was first published on R-post | Cosima Meyer, and kindly contributed to R-bloggers]. (You can report issue about the content on this page here)
Want to share your content on R-bloggers? click here if you have a blog, or here if you don't.

Is there anything better than having a personalized landing page that guides the visitors and allows you to point them towards what really matters? It’s hard to say yes. Luckily, GitHub offers you exactly this possibility and here’s a short guide how I set up my own (personalized) README on GitHub in three steps.1

  1. Create a new public repository with a in its root.2 The repository should have the same name as your GitHub username.
  2. Once you have this, you’ll see something like this — and if you click on the pen symbol (red circle) and it will lead you to the repository where you can customize everything.

  1. Now you can change anything that you want. You can add some text info, add more fancy stuff such as automatized overviews, or also banners. Adding the banner was actually the tricky part for me. Once you have a banner or an image that you want to add (I did mine in Procreate), store it in your folder (I stored mine in img). To access it, you have to use the full URL as shown in the raw code below.

And that’s how the repo looks for me – you just change the README and it pops up as the landing page of your GitHub profile!

  1. I was inspired by the wonderful GitHub README by Monica Powell. ↩︎

  2. Here is an excellent description how to initialize your README. It only works for personal GitHub pages and does not (yet) work for institutions or organizations. ↩︎

To leave a comment for the author, please follow the link and comment on their blog: R-post | Cosima Meyer. offers daily e-mail updates about R news and tutorials about learning R and many other topics. Click here if you're looking to post or find an R/data-science job.
Want to share your content on R-bloggers? click here if you have a blog, or here if you don't.

Never miss an update!
Subscribe to R-bloggers to receive
e-mails with the latest R posts.
(You will not see this message again.)

Click here to close (This popup will not appear again)