<aside> 🚩 Goal: README 파일을 활용하여 프로젝트를 한눈에 알아보게 설명하기

</aside>

[목차]

<aside> 💡 모든 토글을 열고 닫는 단축키 Windows : Ctrl + alt + t Mac : ⌘ + ⌥ + t

</aside>

01. Readme 파일 생성하기

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

• 또한 디렉토리 안에 readme.txt 파일을 생성하여 디렉토리의 설명문을 만드실 수 있습니다.

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

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

• README 파일을 수정하기.
• **markdown 문법**으로 readme 꾸미기

Readme에 들어가는 정보들

• 서비스에 대한 설명.
• 어떻게 사용하는지 설명.