github README 작성

✍️ 과제 하면서 README를 써야 됬어서 찾아 본 것을 토대로 정리해보았다. 찾아본 것을 토대로 업그레이드 하면서 수정해 나가야겠다. (README를 쓰고 있는 내 자신 좀 멋지다. 😼)

개요

1. 프로젝트 제목

• repository 이름 or 프로젝트 제목

2. 프로젝트 로고 or 이미지

• width : 300px 이내, 가운데 정렬

3. 프로젝트 정보

• 소개용 글 5~10줄
• 만든 목적
• 개발 기간

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

4. 배포 주소

• 배포 되었다면 기입

5. 시작 가이드

• 요구 사항
  • 필요한 package 버전들 입력
• 설치 및 실행
  • git clone 코드
  • 환경 변수 설정
  • 실행 명령어

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

6. 기술 스택

• 개발하는데 사용한 기술 스택 나열
• 뱃지 형태로 표현도 좋음.

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

7. 주요 기능

• 프로젝트 주요 기능 소개

8. 팀 소개 (팀이 아니라면 본인 소개)

• 이름, 이메일 주소
• github주소
• 팀이라면 맡은 역할 기재

9. 블로그 링크

• 개발일지 or 회고록 을 작성한 블로그 링크 기재

10. 라이센스

• 보통 MIT

참고 문헌

• https://velog.io/@luna7182/백엔드-프로젝트-README-쓰는-법
• https://github.com/othneildrew/Best-README-Template
• https://cocoon1787.tistory.com/689