7. Readme 작성하기

Github Repository의 얼굴인 Readme를 작성해보는 실습을 진행합니다.

실습 준비

해당 실습 자료는 6. Github Action Workflow 자동화 하기 에서 이어집니다.

작업 브랜치 생성
- 먼저 main 브랜치로 변경 후 git pull 명령어를 통해 새로운 업데이트 사항을 Local Repository로 받아옵니다.
- git branch docs/readme-update명령어로 작업 브랜치를 생성합니다.
  - git checkout docs/readme-update 명령어로 브랜치를 변경합니다.
Markdown 문서 작성 방법
- Readme 는 Markdown 문법으로 작성됩니다. 몇 가지 Markdown 문법에 대해 살펴보겠습니다.
  - 제목(Headers): 제목을 만들 때는 # 기호를 사용합니다. #의 개수에 따라 제목의 수준이 달라집니다. 예를 들어 #은 제목 1을, ##은 제목 2를 의미합니다.
```
# 제목 1
## 제목 2
### 제목 3
```
  - 볼드와 이탤릭(Bold and Italic): 텍스트를 볼드체로 만들려면 * 또는 __로 감싸고, 이탤릭체로 만들려면 `` 또는 _로 감쌉니다.
```
**볼드체 텍스트**
*이탤릭체 텍스트*
```
  - 목록(Lists): 순서 있는 목록은 숫자와 점(1., 2., ...)을 사용하고, 순서 없는 목록은 , `+`, 또는 를 사용합니다.
```
순서 있는 목록:
1. 항목 1
2. 항목 2

순서 없는 목록:
- 항목 1
- 항목 2
```
  - 링크(Links): 링크를 만들 때는 [링크 텍스트](링크 주소) 형식을 사용합니다.
```
[Google](<https://www.google.com>)
```
  - 이미지(Images): 이미지를 삽입할 때는 ![대체 텍스트](이미지 주소) 형식을 사용합니다.
```
![대체 텍스트](<https://example.com/image.jpg>)
```
  - 인용구(Blockquotes): 인용구를 만들 때는 > 기호를 사용합니다.
```
> 이것은 인용된 텍스트입니다.
```
  - 코드 블록(Code Blocks): 코드 블록을 만들 때는 을 사용합니다. 언어에 따라 코드 하이라이팅을 원한다면, 뒤에 언어 이름을 명시할 수 있습니다.
```
```python
    def greet():
    print("Hello, world!")
```

Readme 작성하기

프로젝트 이름
- 프로젝트의 이름을 적습니다.
```
# Github-practice
```

프로젝트 설명

프로젝트에 관한 대략적인 설명을 적습니다.

해당 프로젝트는 Github을 개발자스럽게 사용하기 위한 실습을 포함하고 있습니다.

설치 환경 및 방법
- 프로젝트 사용 시 영향을 줄 수 있는 환경에 대해 적습니다.
  - 설치된 라이브러리에 대해 모두 작성할 필요는 없지만, 라이브러리 관리 툴은 언급해볼 수 있습니다. (pip, conda, poetry 등)
```
## Prerequisites
- Python 3.11 (x86)
- pip

## Installation
```shell
$ pip install -r requirements.txt
```

사용 예시

프로젝트에서 코드를 사용하는 예시를 적습니다.

## How to use
```python
from main import add

a = 10
b = 5

answer = add(10, 5)

print(f"Answer is {answer}")

테스트 코드 실행 예시
- 프로젝트에 테스트 코드가 포함되어 있다면, 테스트를 수행할 때 사용하는 방법을 적습니다.
```
## How to test
```shell
$ pytest tests
```

기여 방법

프로젝트가 오픈소스로 공개되었다면, 어떤식으로 코드를 기여할 수 있는지 적습니다.

## How to contribute
1. 이 저장소를 포크합니다.
2. 새로운 기능이나 버그 수정과 관련된 브랜치를 만듭니다: git checkout -b feat/new-feature 또는 git checkout -b fix/fix-bug.
3. 변경 사항을 커밋하고 푸시합니다: git commit -m "feat: Add new feature" 및 git push origin feat/new-feature.
4. Pull Request를 작성합니다.

라이선스

프로젝트에 적용되는 라이선스에 대해 적습니다.

## License
이 프로젝트는 MIT 라이선스를 따릅니다. 자세한 내용은 LICENSE 항목을 참조하세요.

Licence 파일 작성하기

LICENCE 파일을 추가하고 내용을 다음과 같이 입력합니다.

당해년도와 유저 이름을 작성합니다.

MIT License

Copyright (c) [year] [fullname].

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Readme 갱신하기
- 작성한 Readme, LICENCE 파일을 commit 및 push 합니다.
- 다음과 같이 Pull Request를 작성합니다.
- 리뷰가 승인되었다고 가정하고, Merge 합니다.
- Github Repository의 메인 페이지로 이동하면 갱신된 Readme를 확인할 수 있습니다.