README 작성요령

This is a summary of what I learned from "Codecademy".

README 작성요령

• 프로젝트 제목 : 프로젝트 이름
• 설명 : 이것은 README의 매우 중요한 구성 요소입니다. 프로젝트의 주요 목적을 설명해야 합니다. "이 프로젝트를 만든 이유는 무엇입니까?"와 같은 질문에 답하십시오. 그리고 "어떤 문제를 해결합니까?" 또한 프로젝트에 대한 동기와 이를 통해 배운 내용을 포함하는 데 도움이 됩니다.
• 기능 : 프로젝트에 여러 기능이 있는 경우 여기에 나열하십시오. 프로젝트에 눈에 띄는 고유한 기능이 있다면 자랑하는 것을 두려워하지 마십시오. 기능을 보여주기 위해 스크린샷과 gif를 추가할 수도 있습니다.
• How to use : 여기에 프로젝트를 설치하고 사용하는 방법에 대한 단계별 지침을 작성해야 합니다. 모든 소프트웨어 또는 패키지 요구 사항도 여기에 나열되어야 합니다.
• 기술 : 사용한 모든 기술 및/또는 프레임워크와 프로젝트에서 사용하는 용도를 나열합니다.
• 공동 작업자 : 다른 사람이 어떤 식으로든 귀하의 프로젝트에 기여한 경우, 그들의 작업에 대한 공로를 인정하는 것이 중요합니다. 팀 구성원 또는 공동 작업자의 이름을 GitHub 프로필에 대한 링크와 함께 여기에 작성하십시오.
• 라이선스 : 다른 개발자가 프로젝트에서 할 수 있는 작업과 할 수 없는 작업을 이해할 수 있도록 README에 라이선스를 나열하는 것도 중요합니다. 이 가이드 를 사용 하여 라이선스를 선택할 수 있습니다.