README.md 작성법

take_the_king·2024년 11월 29일
git

Git

목록 보기
9/9

1. Readme 파일 생성

위 사진처럼 깃헙에서 수동적으로 repository를 만들 때 Add a README file 체크하고 만들거나, 직접 README.md 파일을 만들어 깃헙 repository에 push 하기!

  • 또한 디렉토리 안에 readme.txt 파일을 생성하여 디렉토리의 설명문을 만드실 수 있습니다.
    • 예) elements라는 디렉토리 안에 readme.txt 파일을 생성하고 내용을 아래와 같이
      설명하실 수 있습니다.

2. Readme 파일의 내용을 작성및 수정하기

1) README 파일을 수정

1. github에서 아래에 보이는 **`연필 아이콘`**을 누르면 수정하는 페이지로 이동합니다.

  1. Edit file에서 글을 작성하고 Preview를 눌러 GitHub에 어떻게 보여지는지 확인할 수 있습니다

2) markdown 문법

  • 제목, 부제목


    제목이나 부제목을 입력하고 싶다면 앞에 #을 붙이면 됩니다.
    # 을 하나 입력하면 HTML의 h1태그와 같고
    ## 이렇게 두 개 입력하면 h2 태그를, 총 h6 까지 사용이 가능하며 # 의 개수가 늘어날 때마다 하위 단계의 제목으로 설정됩니다.

  • 기운 글씨

    기울임 꼴을 사용하고 싶다면 텍스트를 * 혹은 _으로 감싸주면 됩니다.

  • 굵은 글씨

    굵은 글씨를 사용하고 싶다면 텍스트를 ** 혹은 __으로 감싸주면 됩니다.
    굵고 기울게 하려면 *** 혹은 ___ 이렇게 3개씩 입력해주면 됩니다.

  • 취소선

    취소선은 ~~ 물결 두 개로 텍스트를 감싸주면 됩니다.

  • 인용글

    인용글을 사용하고 싶다면 > 화살표를 텍스트 앞에 넣어주면 됩니다.
    화살표를 여러 개 넣어서 겹쳐진 모습으로도 만들 수 있습니다.

  • 글 머리 기호

    목록을 만들 때 유용한 방법입니다. + 또는 * 또는 -을 입력하여 글머리 기호를 출력할 수 있습니다.

  • 구분선, 수평선

    구분선, 수평선을 만들려면 - 또는 * 또는 _을 3개를 입력합니다.

3) Readme에 들어가는 정보들

  • 서비스에 대한 설명.

  • 어떻게 사용하는지 설명.

  • 무슨 기술스택을 사용하였는가.

  • 누구와 같이 협업하여 만들었는가.

    • styled-components

3. 꾸미기

뱃지

https://github.com/Envoy-VC/awesome-badges
자신이 할 수 있는 기술, SNS 등을 공유할 때 유용한 뱃지들입니다.

위 링크에 접속하시면 여러가지 뱃지들이 나오게 되는데요. 이때 자신이 넣고 싶은 뱃지의 URL을 복사하여 ![](URL_링크) 이런식으로 붙여넣어주면

위의 사진과 같은 결과물이 나오게됩니다.

백준 티어

https://github.com/mazassumnida/mazassumnida
알고리즘 문제를 푸는 사이트인 백준의 티어를 가져올 수 있는 도구에요.

[![Solved.ac
프로필](http://mazassumnida.wtf/api/v2/generate_badge?boj=wke1wke1)](https://solved.ac/wke1wke1)

적용법은 위와 같고, boj=wke1wke1 에서 wke1wke1 부분을 자신의 백준 아이디로 변경해주시면돼요.

적용한 이후 미리보기는 위와 같습니다.

방문자 수

https://hits.seeyoufarm.com/
방문자 수를 체크할 수 있는 도구입니다. 위 사이트에 접속합니다.

접속하셔서 github.com/ 뒤에 본인의 github 아이디를 입력해주세요! 그리고 MARKDOWN 우측 아래에 있는 COPY 버튼을 클릭하셔서 복사합니다.

붙여넣은 결과물은 위와 같습니다.

Most Language

https://github.com/anuraghazra/github-readme-stats

[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=yohan050605)](https://github.com/anuraghazra/github-readme-stats)

자신이 주로 사용하는 프로그래밍 언어를 공유할 수 있는 도구입니다.

제 깃허브는 현재 만든지 얼마 되지 않아 집계할 수 없다고 뜨는데요..

코드들을 업로드하시다보면 위와 같이 통계가 잡혀 어떤 언어를 어느 정도 사용했는지를 공유할 수 있습니다.

Github Stats

https://github.com/anuraghazra/github-readme-stats

[![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=yohan050605)](https://github.com/anuraghazra/github-readme-stats)

api?username=자신의깃허브고유아이디 로 변경해주시면 됩니다.

깃허브 프로필에서 요쪽이 본인의 깃허브 고유 아이디입니다.

결과는 위와 같습니다. 깃허브에서 코드를 업로드하며 협업을 지속적으로 하다보면 등급이 올라가게될거에요.

https://github.com/kyechan99/capsule-render
Header 및 Footer를 예쁘게 꾸밀 수 있는 도구입니다.

위 사이트에 접속하여 본인의 마음에 드는 type, color, height, section, text, fontSize 등을 골라 채워넣습니다.

![header](https://capsule-render.vercel.app/api?type=wave&color=auto&height=300&section=header&text=capsule&fontSize=90)

저는 이런식으로 옵션들의 값들을 채웠고

결과물은 위와 같습니다.

다른 사람의 RADME 코드 가져오기

위의 방법들을 참고해서 꾸며봐도 마음에 들지 않거나, 어떻게 꾸며하는지 감도 안오시는 분들도 있을거에요. 그럴땐 남의 README를 배껴봅시다!

다른 사람의 프로필 메인으로 들어가 빨간 박스 부분을 클릭해줍니다.

그렇다면 그 사람의 README.md 가 저장된 레포지토리로 이동하게 되는데요. README.md 파일을 클릭해줍시다.

이후 오른쪽 상단에 뜨는 연필 모양 아이콘을 클릭하여 Fork this repository and edit this file 을 진행해줍니다.

클릭하게되면 레포지토리를 Fork 할거냐고 묻는데요. Fork를 간단히 설명하면 다른 사람의 레포지토리를 내 레포지토리로 복사해온다고 생각하면 편해요.

Fork this repository 를 클릭하여 Fork를 진행해줍니다.

Fork를 진행하게 되면 위와 같이 그 사람이 작성한 README.md 파일의 코드가 보이게되는데요 복사하고, 위에서 알려준 도구들을 응용해서 본인의 입맛에 맞게 수정해줍니다.

다른 사람의 README를 입맛에 맞게 수정했으니 Fork해온 레포지토리를 본인의 Repositories에서 삭제해보도록합시다. Repositories에 가게되면 Fork 해온 Repository가 있을텐데요. 클릭하여 들어가줍니다.

해당 레포지토리의 Settings 로 이동하여 아래로 쭉 스크롤을합니다.

아래쪽으로 가게되면 위와 같이 Delete this repository가 보일텐데 Delete this repository 를 클릭하여 레포지토리를 삭제해줍니다.

다시 본인의 Repositories로 가보면 Fork 한 레포지토리가 삭제된 것을 볼 수 있습니다.

출처 : https://velog.io/@noyohanx/GIT-%ED%94%84%EB%A1%9C%ED%95%84-%ED%99%94%EB%A9%B4-%EA%BE%B8%EB%AF%B8%EA%B8%B0

4. 참고 사항

이미지 사이즈 조절

  1. 마크다운 형식(이미지 사이즈 조절 불가)
![image](https://user-images.githubusercontent.com/51365114/119627750-716f3100-be47-11eb-8e83-686b23c2c161.png)
  1. HTML 태그 방식(이미지 사이즈 조절 가능)
<img src="https://user-images.githubusercontent.com/51365114/119627750-716f3100-be47-11eb-8e83-686b23c2c161.png  width="200" height="400"/>
#이미지 사이즈 조절 없이 올리는 경우
![image](이미지주소.png)

#이미지 사이즈 조절해서 올리는 경우
<img src="이미지주소.png" width="200" height="400"/>

참고

https://gist.github.com/ihoneymon/652be052a0727ad59601

https://github.com/othneildrew/Best-README-Template

profile
take_the_king
개발을 좋아하는 taketheking 입니다.
이전 포스트

좋은 git Commit 하는 법 [컨벤션]

0개의 댓글