GitHub Profile README File

How to Build an Awesome GitHub Profile

Do you want to build an awesome GitHub README file including Medium, Youtube, and so on?

Photo by Praveen Thirumurugan on Unsplash

Hello there,

in this story, I am going to talk about how to build an awesome GitHub Profile README file. I know there are a lot of blogs about that but I can claim that this is different from them. You can look at my GitHub page or the gif of my GitHub Profile at the bottom of this paragraph.

This gif is from my GitHub Profile

Alierenkayhan - Overview

Content:

1. What Is GitHub Profile README
2. Why Is a Good GitHub Profile Important
3. What Can You Add
4. Steps For Build GitHub Profile
5. The End

+ Are you ready?

— I Am Groot 🌌🌳🦝

+ Good, let’s start 🙂

What Is GitHub Profile README

It is a GitHub feature that allows us to write about ourselves by using Markdown and HTML.

You can write your skills, your blogs, your youtube channel, your interests, your knowledge (language, technical, etc.), your ideas, and so on.

Why Is a Good GitHub Profile Important

GitHub is a very important platform for developers. It can be claimed that GitHub Profile is a kind of special repository that is like your portfolio (resume, CV). With that special repo, you can impress other developers and employers to check out your work.

What Can You Add

Just like my GitHub Profile, you can add some information and even some games. For example, you can add;

• icons for code language and social accounts,
• gif like a wave before my name,
• your blogs from Blogger or Medium with GitHub actions (I will tell you how to do it in the next part),
• a banner that reflects your work,
• an image,
• your contact info,
• your GitHub trophy,
• a download button for your CV,
• GitHub info,
• Youtube Videos,
• a link,
• code …

The list can be longer 🙂

Steps For Build GitHub Profile

Are you excited?

Giphy link

Okay, Let’s build our own GitHub Profile README file.

Step 1: Go to GitHub

• GitHub.

Step 2: Click Sign Up

• Enter your e-mail and fill in the necessary information.

Note: If you are a student, you can get GitHub Student Developer Pack. I suggest you apply this. It offers freely using platforms that you must pay.

Step 3: Creating a repository

• Log in to GitHub.
• Click “+” and “New repository”.

This image is from my GitHub Profile

• You will see this screen;

This image is from my GitHub Profile

• Repository name = Your username.
• Description (optional) = You can write like “I’m Ali Eren Kayhan. 💻 Game Developer & Designer | 🚀Entrepreneur | 💬 TED Translator & Reviewer | ✍️Blogger | Boun EduTech President | 🌱 Senior Student @ CET Boğaziçi University — Develop 2D-3D game with Unity”.
• Public/Private = It must be Public.
• You can add the “README” file.
• You can choose the MIT license.

After you create the repo, you can add tags. Like blogger, game-developer, and so on. To add tags and change description;

• Go to the repo.
• You will see “About” on the right of the page.
• Click the button opposite “About”.

Step 4: Build a Structure

• Okay, I continue with my GitHub Profile structure.
• We will use this structure for each part.

Made By Using Carbon

Step 5: Before About Me Part

This image is from my GitHub Profile

First, we add “Visitor Counter”;

— Go to this website and set your visitor counter how you want.

— Then copy the Markdown or HTML and go to your repo.

— Click to “Edit Readme” and paste it.

I create the banner with canva and photoshop. You can find online image corner rounder and compression in case you need them. You can add it with HTML.

Made By Using Carbon

You write “Hi,” and add the gif same method, and then write “I’m Your Name and Surname”.

Then, write your title.

To create a download button, go to this website. And create your own download button.

Before you add it, upload your CV (resume) to your repo (I suggest you create a folder and put your CV and then upload your folder). Then you should write a href="folder path" and then add your download button code.

You can find “Followers” and “Starts” on this website.

Step 6: About Me Part

This image is from my GitHub Profile

First, use our structure.

You can add emoji in the headings.

You can add an image and use align="right" and width="" height=""

Go to this website, and choose your trophy style.

Do this inside of the “details”.

Step 7: My Account Part

This image is from my GitHub Profile

Create our structure again and change names. We will use it every other step.

Go to this website and find your social media badges.

You should add them as an image, which means use image src="badges's URL" then you can edit them. To align the center, use align="center"

Then use a href="website URL"

Step 8: Languages and Tools Part

This image is from my GitHub Profile

After using our structure, you can create a table and write your technical knowledge.

Go to this website and find your technology, IDE, etc.

Add them as an image and then you can control them more easily.

Step 9: GitHub Information Part

This image is from my GitHub Profile

Go to this website for GitHub status and select your type.

Add your GitHub status as an image to arrange its place. You can arrange it by using align="center"

Step 10: GitHub Repositories Part

This image is from my GitHub Profile

After using our structure, from the same website you can select your type and show your repo.

For “Show More”, you can add search emoji and give them a link to your repository.

Step 11: My Lastest Blog Part

This image is from my GitHub Profile

This is a significant part because we use GitHub actions, which means we don’t add our blog manually but GitHub adds our blog automatically.

• Go to this website and select your platform and copy the code.
• Go to your README.md file and write <! — BLOG-POST-LIST:START →<! — BLOG-POST-LIST:END → this is where you want to see your blogs.
• Then go to your repo and create .github/workflows
• Name your workflow.yml
• Past the code here.
• Wait awhile and if you do everything exactly you don’t have a problem.
• You can check it by going to the repo’s action.

Step 12: My Lastest TED videos that I translate Part

This image is from my GitHub Profile

You do exactly the same in this part and the next part except changing the name’s URL and code.

Step 13: My Lastest Youtube Videos Part

This image is from my GitHub Profile

You do exactly the same in this part except changing the name’s URL and code.

Step 14: My Lastest Game Part

This image is from my GitHub Profile

You add your game image and give it a link.

For the capsule render, you can find it on this website. You can change its style with CSS.

The End

Author: Ali Eren Kayhan

Publication: Not Tutuyoruz

Let me know what you think about my story. If you like, please share and clap. Besides this, if you want me to write a topic that I know, please write me. Feel free to contact me. Don’t forget to follow my accounts and Not Tutuyoruz 🙂

To see my other works, please visit my personal website

Home | Alierenkayhan.github.io

Sonra görüşürüz,

See you later,

Bis später.

Giphy link