[Github] README란? README.md 작성법

 

README 란?

Github에 프로젝트를 올릴 때, 프로젝트에 대한 설명뿐 아니라 사용 방법, LICENSE 등의 내용을 기술하는 파일이다.

 

 

 

 

README를 작성해야 하는 이유

어떤 프로그램을 사용하거나 오픈소스를 참고하기 위해 Github Repository에 들어간다면, 가장 먼저 확인하는 것이 README 파일이다.

다른 사용자들이 내 오픈소스 프로젝트에 대한 정보를 얻기 위해,

해당 프로젝트에 대해 함께 협업하는 동료에게 정보를 주기 위해,

나중에 다시 내가 프로젝트를 다시 열었을 때 떠올리기 용이하기 위해

README를 잘 작성해 둘 필요가 있다.

 

 

 

일반적인 README 구조

1. 프로젝트 Description

- 프로젝트 명

- 어떤 프로젝트인지 소개

2. 프로젝트 정보

- 설치(Getting Started / Installation)

- 컴파일 방법, 사용 환경, 브라우저 서포트(웹 프로젝트라면!)

- 간단한 사용 방법 및 예제

3. Contribute

- 다른 사람들이 코드에 Contribute하기 쉽도록 설명

- 어떤 류의 Contribute를 원하는지 또는 Contributing 규칙 등을 적을 수도 있다.

4. LICENSE

- 라이선스 : 저작물의 수정 배포에 대한 권한이나 저작권들에 대한 조항들

- 보통 MIT License를 많이 사용하고 BSD 라이선스도 많이 사용한다

5. 외부리소스 정보

- 프로젝트에 포함된 외부 코드나 리소스 정보(각각의 출처 및 배포 라이선스)

6. Code Status

- Shield라는 것을 사용하여 [build | passing]과 같은 정보를 줄 수 있다.

- 프로젝트가 커질수록 도움이 되는 부분

 

 

 

 

My READMD 구성

내 깃허브 링크 : https://github.com/syun32

syun32 - Overview

지금까지의 깃허브 Repository들은 개발 과정에서 README를 작성하지는 않았었기에, 최근에 README 파일을 깔끔하게 작성하기로 했다.

IT기업 기술 블로그에 올라온 브이로그에서 이슈 처리한 부분을 동료들과 협업을 위해 README에 업데이트를 하는 모습을 보고 제대로 된 README 작성법과 내 REPOSITORY README를 수정하기로 했다! 👊

추후 내 활동들에 관심을 가지는 사람들이나 내 스스로 프로젝트를 돌아보기 용이하기 위해  README를 다시 작성할 것이기에 다음과 같이 간단하게 구성할 것이다.

1. 프로젝트 Description

- 프로젝트 이름 및 설명

 

2. 프로젝트 정보

- 프로젝트 개발 환경 및 사용 기술

 

3. 프로젝트 결과물

- 기능 [기능 흐름에 따라 / 기능 나열]

- 결과 예시 화면