You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: projects/make-a-github-readme/make-a-github-readme.mdx
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,26 +19,28 @@ tags:
19
19
20
20
## Introduction
21
21
22
-
[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 and recruiters often asking for links to your GitHub when you apply to jobs. It’s one of the best ways for them to see what you’ve actually built, not just what you’ve written on your resume.
22
+
[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 and recruiters often asking for links to your GitHub when you apply to jobs. It’s one of the best ways for them to see what you’ve actually built, not just what you’ve written on your resume. 🐙
23
23
24
-
But did you know that there's a way to personalize your GitHub to make your personality stand out?
24
+
But did you know that there's a way to personalize your GitHub to make your personality stand out?!
25
25
26
-
It's a profile README! This is my README for example:
26
+
It's a profile README! 👤 This is my README for example:
27
27
28
28
<imgsrc="https://i.imgur.com/egLVWhL.png" />
29
29
30
30
A **README file** is a file in a code repository that tells others about your project, like an introduction. It can explain what a project does, setup information, and credits the project's contributors.
31
31
32
-
It usually lives in the root folder of a project and is named **README.md** (the **.md** stands for Markdown, a lightweight way to format text).
32
+
It is named **README.md** (the **.md** stands for Markdown, a lightweight way to format text).
33
33
34
-
In this project tutorial, we're going to make a **profile** README – a file that tells others about YOU! Think of your profile README as an "About Me" page on a website.
34
+
In this project tutorial, we're going to make a **profile** README – a file that tells others about YOU! It's the first thing that people see when they land on your GitHub profile. Think of your profile README as an "About Me" page on a website.
35
35
36
36
Let's get started.
37
37
38
38
## Making the Profile README
39
39
40
40
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.
41
41
42
+
Then, follow these steps:
43
+
42
44
1. Make sure you're signed into GitHub.
43
45
2. Find the + button in the upper right corner of the header, and then click "New repository".
44
46
3. You'll be prompted to write a repository name. Make this exactly your GitHub username. For example, if your username is `codedex_user`, name your repository `codedex_user`.
0 commit comments