27. (Bitbucket/Git) [Git] README.md 파일 설명

---

[환경 설정]

​

저장소 : Bitbucket / Git

​

사용 목적 : 소스 코드 버전 관리 실시

 

---

[설 명]

​

1. README.md 란 프로젝트의 내용을 설명하기 위해 사용하는 파일로써 프로젝트가 어떤 목적에 의해 개발되었는지, 어떻게 사용할 수 있는지 등을 작성해 놓은 파일 입니다

​

​

2. README.md 파일 은 git 저장소의 메인 페이지에 노출 되며, 개발 환경 , 필수 설정 , 프로젝트 설명 등을 작성 합니다

​

​

3. README.md 파일 작성 장점 :

​

- 문서를 통해 중요한 내용 및 설정을 살펴 봄으로써 전반적인 프로젝트 진행 상황 및 구조를 이해하기 쉽습니다

​

- 프로젝트 협업 시 팀원들이 참고하기 좋은 지침서 역할을 수행합니다

 

---

[참고 사이트]

​

https://nohack.tistory.com/20

프로젝트를 멋지게 설명하는 README.md

---