-
[Git,GitHub]3. GitHub의 README.md 작성예시programming/Git,Github 2021. 1. 5. 15:06
README.md
깃허브에서 대부분, 아니 거의 모든 프로젝트에는 빠지지 않는 파일이 있습니다. 바로 README 파일입니다.
README파일은 README.TXT, README.md README.1ST, READ.ME 다양한 파일의 형태로 만들기도 하는데 보통은. md 확장자 마크다운 언어를 사용해서 작성하고
- 프로젝트가 어떤 프로젝트인지 설명하거나
- 프그램의 주요 사용법을 알려주거나
- 프로그램을 실행시키려면 어떤 사전작업이 필요한지를
- 라이센스에 관해서
알려주는 내용이 적혔잇습니다.
GitHub에서는 README파일을 프로젝트의 메인 화면에 보여주기 때문에 README.md 파일의 내용을 가독성이게 작성하는 것이 중요합니다.
아래는 Numpy의 README.md입니다.
프로젝트 README.md 파일을 작성하실 때 한번 참고해보시면 좋을 듯합니다.!
'programming > Git,Github' 카테고리의 다른 글
[Git,GitHub]Git 로그인 실패 Error, Access Token 발급 받는법 (0) 2022.04.04 [Git,GitHub]2. Git의 기본개념 (0) 2021.01.04 [Git,GitHub]1. Git이란? GitHub란? (0) 2021.01.03