카테고리 없음

READ ME 작성방법

rlarudals 2024. 8. 28. 21:00

프로젝트에 대한 정보

(1) 프로젝트 제목

Github Repository 이름이나 프로젝트 제목을 적어준다.

(2) 프로젝트 로고나 이미지

프로젝트를 대표하는 사진이나 로고를 넣어준다. 너비를 300정도로 해주는 것이 보기 좋고, 가운데 정렬을 해준다.

(3) Repository 방문 횟수

필수적인 요소는 아니다. Repository에 얼마나 많은 사람들이 방문했는지를 알 수 있는 카운터인데, 뭔가 숫자가 올라가는 것을 보면서 Repository를 좀 더 열심히 관리해야겠다는 마음에 추가하게 되었다. --> https://hits.seeyoufarm.com/

(4) 프로젝트 정보

해당 프로젝트를 진행한 단체나 목적에 대해 소개하고, 개발 기간을 써준다.

(5) 배포 주소

프로젝트가 배포되어 있다면, 해당 주소를 기입해준다.
나의 경우에는 웹사이트 주소, 프론트 엔드 배포 주소, 백엔드 배포 주소 이렇게 3개를 써주었다.

(6) 팀 소개

프로젝트를 팀으로 진행하였다면, 팀원들에 대한 소개를 써준다.
이름과 사진, 깃허브 주소, 소속 학과에 대해 써주면 충분할 듯하다. 추가적으로 맡은 역할에 대해 써줘도 좋을 것 같다.

(7) 프로젝트 소개

진행한 프로젝트에 대해 간단하게 5~10줄 정도 써준다.