Git

[GitHub] README

SangRok Jung 2022. 12. 28. 00:40
반응형

README


  • 깃헙 저장소에서 프로젝트가 무슨 일을 하는지 설명하기 위한 파일이다.
  • 무엇을 위한 것인지, 누구를 위한 것인지, 프로젝트를 어떻게 시작하고 실행하는지, 필요한 라이브러리가 있다면 어떻게 설치하는지 누가 프로젝트를 관리하는지, 어떻게 공동 작업하고 도움을 받는지 같은 정보가 적힌다.
  • 프로젝트에 README.md파일을 넣으면 깃허브가 자동으로 표시한다.
  • md는 Markdown의 약자.
    • markdown은 text를 HTML로 변환하는 도구.

 

 

 

markdown-it

https://markdown-it.github.io/

 

markdown-it demo

 

markdown-it.github.io

 

 

 

반응형

'Git' 카테고리의 다른 글

[GitHub] Pull Request  (0) 2022.12.28
[GitHub] work flow  (0) 2022.12.28
[GitHub] public & privacy  (0) 2022.12.28
[GitHub] Adding Collaborators  (0) 2022.12.28
[GitHub] Fetching & pulling  (0) 2022.12.28