Github - 자신의 Repository에 READMD.md 작성해보기

README란 ?

readme란 프로젝트에 대한 간단한 설명을 담고 있는 문서이다. 일반적으로 git에서 특정 레포지토리에 들어가면 가장 먼저 보이는 main page가 바로 readme이다. 이런 readme 파일은 일반적으로 markdown 문법으로 작성된다.(확장자는 md) 쉽게 말해 readme를 작성한다는 것은 구현한 프로젝트를 문서화하는 작업이다.
출처 : https://otugi.tistory.com/172

README를 작성하는 이유로는 여러가지가 있겠지만 가장 첫번째로는 이 프로젝트에 대해 다른사람이 보았을때 한 페이지로 프로젝트에 대한 정보를 알아 볼 수 있게 하기 위함이다.

README는 어떻게 작성하는지..?

README를 작성할 때 형식이 정해져있거나 하지는 않지만, 마크다운형식을 사용하여 작성하면 좀 더 가독성 좋은 README를 작성 할 수 있다.

마크다운에 대해 알아보기

마크다운을 사용하여 README 작성해보기

작성중인 페이지

페이지에 보여지는 모습