포스트

[GitHub 100일 챌린지] Day 4 - 프로필 README 기본

[GitHub 100일 챌린지] Day 4 - 프로필 README 기본

100일 챌린지 Day 4 - 스페셜 프로필 README를 만듭니다

배울 내용

  1. 프로필 README란 무엇인가
  2. 스페셜 Repository 만들기
  3. 기본 README 작성하기

Topic1. 프로필 README란 무엇인가

GitHub의 숨겨진 기능

사용자 이름과 같은 이름의 Repository를 만들면, 프로필 페이지에 표시되는 스페셜 README를 만들 수 있습니다!

1
2
3
4
5
6
7
8
9
10
일반 프로필:
- 프로필 사진
- Bio
- 저장소 목록

프로필 README 있는 프로필:
- 프로필 사진
- Bio
- ✨ 커스텀 README ✨  ← 추가!
- 저장소 목록

프로필 README로 할 수 있는 것

  • 📝 자세한 자기소개
  • 💻 기술 스택 표시
  • 📊 GitHub 통계
  • 🎯 현재 하고 있는 일
  • 📫 연락 방법
  • 🌐 블로그/포트폴리오 링크

프로필 README는 “나를 멋져 보이게 만드는 장식”보다 “방문자가 30초 안에 나를 이해하게 하는 안내판”에 가깝습니다. 처음에는 화려한 배지나 통계 위젯보다, 현재 배우는 것과 대표 프로젝트를 명확히 적는 것이 더 좋습니다.

예시:

1
2
https://github.com/사용자명
→ 프로필 상단에 README 내용 표시

Topic2. 스페셜 Repository 만들기

사용자명과 동일한 Repository

핵심: Repository 이름 = GitHub 사용자명

예시:

  • 사용자명이 johndoe라면
  • Repository 이름도 johndoe로 생성

해보기:

1
2
3
4
5
6
7
8
1. GitHub 메인 페이지 접속
2. 우측 상단 "+" 클릭
3. "New repository" 선택
4. Repository name: [본인 사용자명] 입력
   (예: youngsu-park)
5. ✅ Public 선택 (필수!)
6. ✅ "Add a README file" 체크
7. "Create repository" 클릭

결과:

1
2
3
🎉 You've discovered a special repository!
yourname/yourname is a special repository.
Its README will appear on your profile!

이 메시지가 나타나면 성공!

프로필 README 저장소는 반드시 public이어야 프로필에 표시됩니다. 또한 저장소 이름은 사용자 이름과 정확히 같아야 합니다. 대소문자나 하이픈이 헷갈리면 프로필 URL에 보이는 사용자명을 그대로 복사해서 붙여넣으세요.


Topic3. 기본 README 작성하기

README.md 파일 편집

생성된 Repository의 README.md 파일을 편집합니다.

해보기:

1
2
3
1. 방금 만든 Repository 페이지로 이동
2. README.md 파일 클릭
3. 우측 연필 아이콘(✏️) 클릭

기본 템플릿

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# 안녕하세요! 👋

저는 [이름]입니다.

## 🔭 현재

- 공부중: Python, JavaScript
- 관심분야: 웹 개발

## 🧩 최근 프로젝트

- [프로젝트 이름](https://github.com/username/project): 한 줄 설명

## 📫 연락

- Email: [email protected]
- Blog: https://yourblog.com

실전 예시

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Hi there! 👋 저는 김영수입니다

## 🌱 About Me

- 💻 웹 개발을 배우고 있는 주니어 개발자입니다
- 📚 현재 React와 Node.js를 공부 중입니다
- 🎯 목표: 풀스택 개발자

## 🛠 Tech Stack

**배우는 중:**
- Frontend: HTML, CSS, JavaScript
- Backend: Node.js
- Tools: Git, GitHub

## 📫 Contact

- Email: [email protected]
- Blog: https://blog.example.com

좋은 프로필 README는 과장된 문장보다 구체적인 링크가 강합니다.

피하기 바꾸기
“모든 기술을 잘합니다” “React와 Node.js를 배우며 작은 앱을 만들고 있습니다”
“최고의 개발자가 되겠습니다” “매주 학습 기록과 프로젝트를 업데이트합니다”
배지만 20개 나열 대표 기술 3-5개와 실제 저장소 링크

저장하기:

1
2
3
4
5
1. 내용 작성 완료
2. 하단 "Commit changes" 클릭
3. "Commit message" 입력 (예: "Add profile README")
4. "Commit directly to the main branch" 선택
5. "Commit changes" 버튼 클릭

결과: 프로필 페이지(github.com/yourname)에서 README 확인 가능!

Markdown 기본 문법

1
2
3
4
5
6
7
8
9
10
11
# 제목 1 (가장 큼)
## 제목 2
### 제목 3

**굵은 글씨**
*기울임*

- 리스트 항목 1
- 리스트 항목 2

[링크 텍스트](https://example.com)

첫 README 최소 구조

처음에는 아래 네 섹션만 있어도 충분합니다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# Hi, I'm [이름]

## About
- 현재 배우는 것:
- 관심 있는 분야:

## Projects
- [프로젝트명](링크): 무엇을 만든 프로젝트인지 한 줄 설명

## Learning Log
- GitHub 100일 챌린지 진행 중

## Contact
- Blog:
- Email:

README를 만든 뒤에는 모바일 화면에서도 읽기 쉬운지 확인하세요. 긴 배너 이미지나 너무 많은 배지는 작은 화면에서 오히려 방해가 될 수 있습니다.


정리

완료 체크:

  • 프로필 README의 개념을 이해했다
  • 사용자명과 동일한 Repository를 만들었다
  • 기본 README를 작성했다
  • 내 프로필 페이지에서 README를 확인했다
  • README에 대표 프로젝트 또는 학습 기록 링크를 넣었다
  • 과장된 표현보다 구체적인 현재 상태를 적었다

: README는 언제든 수정 가능합니다. 부담 갖지 말고 일단 만들어보세요!

다음: Day 5 - 프로필 README 고급

이 기사는 저작권자의 CC BY 4.0 라이센스를 따릅니다.