[GIT] github README 작성하기

 

👩🏻‍💻 Readme 작성 요령

 

1. 프로젝트 Description

• 프로젝트명
• 프로젝트 소개
• 디렉토리 구조

 

2. 프로젝트 정보

• 설치 방법
• 컴파일 방법, 사용 환경, 브라우저 서포트, 구현 목록
• 간단한 사용 방법 및 예제

 

3. 프로젝트 결과물

• 기능별 사진/동영상
• 코드 설명, 후기

 

4. Contribute

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

 

5. LICENSE (저작물의 수정 배포에 대한 권한이나 저작권들에 대한 조항들)

• 보통 MIT License를 많이 사용

 

6. 외부리소스 정보

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

---

✍🏻 마크다운 작성법

https://gist.github.com/ihoneymon/652be052a0727ad59601

---

📑 Readme Template 참고 사이트

https://github.com/sujinleeme/readme-template/tree/master/korean

https://github.com/matiassingers/awesome-readme

---

🪄 Github 프로필 꾸미기

 

https://velog.io/@colorful-stars/Github-%ED%94%84%EB%A1%9C%ED%95%84-%EA%BE%B8%EB%AF%B8%EA%B8%B0

Github 프로필 꾸미기

https://velog.io/@imysh578/github-Profile-%EA%BE%B8%EB%AF%B8%EA%B8%B0

[github] Profile 꾸미기

 

header

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

GitHub - kyechan99/capsule-render: 🌈 Dynamic Coloful Image Render

 

깃허브 status

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

 

boj 프로필

https://github.com/mazassumnida/mazassumnida

GitHub - mazassumnida/mazassumnida: Github 프로필에서 boj 프로필을 이쁘게 보여주는 프로젝트

 

스킬뱃지

https://simpleicons.org/

Simple Icons

 

 

 

---

코드관리를 하며 제일 가깝게 사용되는 깃허브

커밋 명령어만 신경써서 푸시하고 정작 더 중요한 레드마인은 방치해 둔 나.. 반성하자

모든것의 첫인상이 중요하듯 프로젝트의 첫인상은 레드마인!

틈틈이 이전 프로젝트들 레드마인도 추가해야겠다

❓ readme는 영어 표기법으로 되어 있어서 '레드마인', '리드미' 등 다양하게 불려지는 것 같다. 나는 첫 회사에서 모두가 레드마인으로 말했기에 자연스레 레드마인으로 따라 부르게 된 케이스랄까