github README 활용하기

📢 마크다운 사용법 https://gist.github.com/ihoneymon/652be052a0727ad59601

📌 README에 정리해야 하는 내용

1. 프로젝트 Description

✔ 프로젝트명
✔ 어떤 프로젝트인지 소개
✔ 디렉토리 구조

2. 프로젝트 정보

✔ 설치방법(Getting Started / Installation)
✔ 컴파일 방법, 사용 환경, 브라우저 서포트, 개발스택, 구현 목록(명세)
✔ 간단한 사용 방법 및 예제

3. 프로젝트 결과물

✔ 기능별 사진 / 영상
✔ 코드설명, 후기(짧고 간결하게 써야함, 내용이 길어질 경우 블로그에 작성한뒤 링크로 연결해주는게 좋다)

4. Contribute

✔ 다른 사람들이 코드에 Contribute하기 쉽도록 방법 설명
✔ 어떤 류의 Contribute를 원하는지 또는 Contributing 규칙 등을 적을 수도 있다.

5. LICENSE

✔ 라이선스 : 저작물의 수정 배포에 대한 권한이나 저작권들에 대한 조항들
✔ 보통 MIT License를 많이 사용하고 BSD 라이선스도 많이 사용한다

6. 외부리소스 정보

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

7. Code Status

✔ Shield라는 것을 사용하여 [build | passing]과 같은 정보를 줄 수 있다.
✔ 프로젝트가 커질수록 도움이 되는 부분

📢 README 템플릿 사이트
https://gist.github.com/PurpleBooth/109311bb0361f32d87a2
https://github.com/sujinleeme/readme-template/tree/master/korean

📌 github prifile 꾸미기

깃허브 stats
https://github.com/anuraghazra/github-readme-stats
https://github.com/anuraghazra/github-readme-stats/blob/master/themes/README.md

boj 프로필
https://github.com/mazassumnida/mazassumnida

header
https://github.com/kyechan99/capsule-render#wave

스킬 뱃지
https://simpleicons.org/
https://shields.io/

👩 깃허브에 오픈소스로 파일을 올리는 경우, 과제로 프로젝트를 제출하는 경우에는 특히나 리드미파일을 잘 작성해주는게 중요하다고 한다. 이전에는 깃허브는 그저 파일을 저장해두고 무료로 사이트를 배포할 수 있는 곳이라고 생각했다. 그래서 커밋내용이나 리드미 파일 같은 부분은 전혀 신경쓰지 못했고 신경써야하는지도 몰랐다. 이제와 조금이나마 그 중요성을 알고보니 내가 그동안 얼마나 겉핥기식으로 사용해왔는지 알 수 있었다.
리드미 파일은 코드보다도 가장 먼저 보여지는 첫 부분이기에 나의 얼굴과도 같다. 예전에 작업한 프로젝트들도 하나하나 리드미파일을 추가하면서 필요한 내용들을 깔끔하게 잘 정리해서 넣는 습관을 만들어보자🔥