깃허브: 리드미 작성법

Project Title: Give a brief but descriptive title to your project.

1. 프로젝트명

먼저 프로젝트의 이름입니다. 한 문장으로 전체 프로젝트를 설명하고 사람들이 프로젝트의 주 목표가 무엇인지 이해할 수 있게 도와줍니다.

---

Project Overview: Provide a brief overview of the project and its purpose. You could mention that it is a website for downloading medical certificates, and briefly explain why such a website might be useful.

2. 프로젝트 설명

이 부분은 많은 개발자들이 간과하는 프로젝트의 주요 요소입니다.

설명은 프로젝트에서 굉장히 중요한 부분을 차지합니다. 잘 다듬어진 설명을 통해 미래의 인사 담당자뿐만 아니라 다른 개발자들에게도 여러분의 작업물을 자랑할 수 있습니다.

리드미에서 설명의 질은 좋은 프로젝트와 그렇지 못한 프로젝트를 구분 짓습니다. 잘 쓰인 리드미를 통해 다음과 같은 내용을 설명하고 소개할 수 있습니다.

• 여러분의 애플리케이션이 무엇을 하는지,
• 왜 그 기술을 사용했는지,
• 여러분이 당면했던 문제나 나중에 추가하고 싶은 기능이 무엇인지

---

Technologies Used: List the programming languages, frameworks, libraries, and other technologies that you used to build the website, such as HTML, CSS, Bootstrap, Java, and Spring.

Features: Describe the features and functionality of the website. For example, you could mention that users can upload their medical information and receive a digital certificate that they can download and print.
Installation Instructions: Provide step-by-step instructions for setting up and running the website on a local machine, including any prerequisites and dependencies.

---

Usage Instructions: Explain how users can interact with the website and make use of its features.
Testing: Describe the testing process that you used to ensure that the website functions correctly, such as unit tests and integration tests.

4. 프로젝트 설치 및 실행 방법

만약 사용자가 따로 설치하거나 포스기와 같은 기계에서 실행해야 하는 프로젝트를 작업하고 있다면, 프로젝트를 설치할 수 있는 방법과 필요한 경우 dependencies를 포함해 작성해야 합니다.

개발 환경을 세팅하고 실행할 수 있는 단계적인 설명을 제공하세요.

5. 프로젝트 사용 방법

사용자/기여자들이 프로젝트를 이용할 수 있는 방법과 예시를 작성하세요. 예상 문제에 대해 항상 참고할 수 있는 곳을 마련함으로써 그들이 문제에 직면했을 때 쉽게 해결할 수 있을 것입니다.

프로젝트 실행 예시 화면의 스크린샷과 같은 시각 자료를 사용할 수도 있고 프로젝트에서 사용된 구조나 디자인 원칙을 추가할 수 있습니다.

프로젝트에 비밀번호나 유저 네임이 필요한 경우 계정을 적어두는 것도 좋은 방법입니다.

---

Future Development: List any potential future features or improvements that you might want to add to the website.

---

Team Members: List the names and roles of all team members who contributed to the project.

Contributors: Give credit to anyone who contributed to the project outside of the team, including any open-source libraries or frameworks that you used.

6. 팀원 및 참고 자료

만약 팀이나 조직 단위로 작업한 프로젝트라면 팀원들을 같이 기재하세요. 팀원들의 깃허브 프로필과 SNS 링크도 연결해야 합니다.

사용자가 프로젝트를 설치하는 데 도움을 줄 수 있는 튜토리얼이나 자료를 참고했다면 그런 링크도 같이 첨부해야 합니다.

이렇게 함으로써 감사를 표현함과 동시에 사람들이 프로젝트의 첫 번째 사본을 얻을 수 있습니다.

---

License: Specify the license under which the project is released, if any.

7. 라이센스

대부분의 리드미에서 라이센스는 가장 마지막으로 고려되는 부분입니다. 라이센스를 보고 다른 개발자들은 여러분의 프로젝트로 무엇을 할 수 있고 무엇을 할 수 없는지 알 수 있습니다.

우리는 작업하고 있는 프로젝트의 종류에 따라 다른 라이센스를 가지고 있습니다. 여러분이 고르는 라이센스에 따라서 프로젝트의 기여가 달라질 수 있습니다.

가장 흔한 라이센스는 다른 사람들이 여러분의 코드를 수정할 수 있고 상업적인 용도로 사용할 수 있는 GPL 라이센스입니다. 라이센스를 고를 때 도움을 받고 싶다면, 이 링크를 확인해 보세요: https://choosealicense.com/

지금까지 좋은 리드미를 위한 최소한의 요건을 살펴보았습니다. 하지만 눈길을 더 사로잡고 상호적인 리드미를 만들고 싶다면 다음 내용을 추가해 볼 수 있습니다.

---

출처: https://www.freecodecamp.org/korean/news/gisheobeu-peurojegteue-rideumi-paileul-jal-jagseonghaneun-bangbeob/

---