Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 118 additions & 0 deletions projects/make-a-github-readme/make-a-github-readme.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
---
title: Make a GitHub Profile README
author: Gabriela Banaag
uid: CgUQBagDrWWBRUuoh3mkyi3aedg1
datePublished: 2025-10-12
description: Learn to make a beautiful GitHub profile README to tell the world about yourself.
header: https://raw.githubusercontent.com/codedex-io/projects/main/projects/build-an-album-finder-with-spotify-api/header.gif
bannerImage: https://raw.githubusercontent.com/codedex-io/projects/main/projects/build-an-album-finder-with-spotify-api/header.gif
published: false
readTime: 30
prerequisites: GitHub account
versions: None
courses:
- git-github
tags:
- web-development
- beginner
---

<BannerImage
link="https://i.imgur.com/YXymp4k.png"
description=""
uid={false}
cl="for-sidebar"
/>

# Make a GitHub Profile README

<AuthorAvatar
author_name="Gabriela Banaag"
author_avatar="https://firebasestorage.googleapis.com/v0/b/codedex-io.appspot.com/o/avatars%2FCgUQBagDrWWBRUuoh3mkyi3aedg1%2Fprofile.png?alt=media&token=bd4976cc-5884-4d84-b819-e1b860cc9e4a"
username="gabtot"
uid=""
/>

<BannerImage
link="https://i.imgur.com/FVLJd7H.png"
description=""
uid=""
/>

## Introduction

[GitHub](https://github.com) is a platform that allows developers to store, track, share, and collaborate on code. It's a big way to display your technical projects and progress through repositories (a space for project code), with companies often asking for links to your GitHub when you apply to jobs.

<img src="https://i.imgur.com/egLVWhL.png">

This is my README!

Did you know that there's actually a way to personalize your GitHub to make your personality stand out? In this tutorial, we're going to make a README file about you that's displayed on your profile!

## What's a README file?

A **README file** is a file in a project repository that tells others about your project. It can explain what a project does, setup information, and credits the projects contributors.

In this tutorial, we'll be making a **profile** README - a file that tells others about YOU! Think of your profile README as an about me page on a website.

[Example]

Make sure you have a GitHub account before we get started! You can create one [here](https://github.com/signup) if you don't have one.

## Making the profile README

1. Make sure you're signed into GitHub.
2. Find the + button in the upper right corner of the header, and then click **New Repository**.
3. You'll be prompted to write a name for your repository. Make this your GitHub username. For example, if your username is `codedex_user`, name your repository `codedex_user`.
4. Select initialize this repository with a README.
5. Make sure the repository is set to **public**. Click **Create repository**.

## Editing the README

Now we're going to add your information to the file. Some things you can highlight:

- Your school, major, and graduation year
- Club, internship, and work experience
- Your proudest accomplishments
- Links to external sites or social media pages
- Anything you want!

READMEs are primarily written with **markdown** - it's a way to format plain text and turn it into things like headers, formatted text (bold, italics, underlines), lists, or links!

Here's a quick guide on how to mark down your text:

- **Headers:** `# Header 1` (add more #s to get smaller headers)
- **Links:** `(Google)[https://google.com]`
- **Images:** `![](https://images.com/cat_img.PNG)`
- **Highlighting code:** ````<script> //code here </script>````
- **Lists:** Put an asterisk (*), dash (-), or number (1.) before each list item. Each option creates bullet points, dashed lists, and numbered lists, respectively.

## Personalizing the README

There are many plugins and ways to personalize your README!

- Images that show a glimpse into what you do, or style the README!
- Emojis
- SVGs (Vector images)
- Here’s a [superlist](https://github.com/abhisheknaiidu/awesome-github-profile-readme?tab=readme-ov-file#tools) of things you can embed - everything from stats on what languages you use, visitor counters, jokes, or even music players!

## Examples for inspo

Here are some from my friends:

<img src="https://i.imgur.com/5Dc7peG.png">

Heldanna has a timeline of her job experience in a table!
<br><br>

<img src="https://i.imgur.com/Fr2KEOp.png">
Grace has a lot of links attached with a nice colored block + logo attached to each link!
<br><br>

<img src="https://i.imgur.com/79iTNwN.png">
Kailey has some cards with stats from her repositories!
<br><br>

## Conclusion

You now have your very own README on your profile! We’d love to see what you’ve made - drop your creations on Discord or Codédex OPC.