Managing your profile README

You can add a README to your GitHub profile to tell other people about yourself.

누가 이 기능을 사용할 수 있나요?

Profile READMEs are not available to 관리형 사용자 계정.

이 문서의 내용

About your profile README

You can share information about yourself with the community on GitHub by creating a profile README. GitHub shows your profile README at the top of your profile page.

You decide what information to include in your profile README, so you have full control over how you present yourself on GitHub. Here are some examples of information that visitors may find interesting, fun, or useful in your profile README.

  • An "About me" section that describes your work and interests
  • Contributions you're proud of, and context about those contributions
  • Guidance for getting help in communities where you're involved

Screenshot of the profile page for @octocato. In the top-right corner, a profile README greets the viewer and lists information about the user's work.

You can format text and include emoji, images, and GIFs in your profile README by using GitHub Flavored Markdown. For more information, see GitHub에서 작성 및 포맷 시작. For a hands-on guide to customizing your profile README, see GitHub에서 쓰기 위한 빠른 시작.

Prerequisites

GitHub will display your profile README on your profile page if all of the following are true.

  • You've created a repository with a name that matches your GitHub username.
  • The repository is public.
  • The repository contains a file named README.md in its root.
  • The README.md file contains any content.

참고 항목

If you created a public repository with the same name as your username before July 2020, GitHub won't automatically show the repository's README on your profile. You can manually share the repository's README to your profile by going to the repository on GitHub and clicking Share to profile.

Adding a profile README

  1. 임의 페이지의 오른쪽 위에 있는 을(를) 클릭한 다음, 신규 리포지토리를 클릭합니다.

    새 항목을 만드는 옵션을 보여 주는 GitHub 드롭다운 메뉴의 스크린샷. "새 리포지토리"라는 메뉴 항목이 진한 주황색 윤곽선으로 표시되어 있습니다.

  2. “리포지토리 이름”에 GitHub 사용자 이름과 일치하는 리포지토리 이름을 입력합니다. 예를 들어 사용자 이름이 “octocat”인 경우 리포지토리 이름은 “octocat”이어야 합니다.

  3. 필요에 따라 ‘설명’ 필드에 리포지토리 설명을 입력합니다. (예: “내 개인 리포지토리”)

  4. 퍼블릭을 선택합니다.

  5. 추가 정보를 사용하여 이 리포지토리 초기화를 선택합니다.

  6. Create repository(리포지토리 만들기)를 클릭합니다.

  7. Above the right sidebar, click Edit README.

The generated README file is pre-populated with a template to give you some inspiration for your profile README.

For a summary of all the available emojis and their codes, see Emoji cheat sheet.

Removing a profile README

The profile README will be removed from your GitHub profile if any of the following apply:

  • The README file is removed or made empty.
  • The repository is made private.
  • The repository name no longer matches your username due to a change in either or both names.

The method you choose depends upon your needs, but if you're unsure, we recommend making your repository private. For steps on how to make your repository private, see 리포지토리 표시 유형 설정.

Further reading