README 작성 가이드

1주차 프로젝트 진행 후 README를 작성해야 한다고 해서 미리 README가 무엇이고

어떻게 작성하면 좋을 지 찾아보았다.

 

README란?

: 프로젝트에 대한 간단한 설명을 담고 있는 문서

일반적으로 git에 들어가면 가장 먼저 보이는 main page를 의미한다. -> readme

이런 readme 파일은 일반적으로 markdown 문법으로 작성한다.(확장자는 md)

-> readme를 작성 한다는 것은 프로젝트를 문법화 시키는 작업이다.

-> readme를 작성하면 나중에 코드를 봤을 때 이해하기 쉽고 다른 사람들이 봤을 때 가독성을 올릴 수 있다.

 

- README 개념 설명 / 작성해야 하는 내용 정리

https://otugi.tistory.com/172

README 작성 가이드

 

- README 작성 방법

https://lsh424.tistory.com/37

Github README.md 작성 방법 및 요령