1. README
README 파일은 프로젝트에 대한 핵심 정보를 담고 있는 매우 중요한 파일이다. 이 파일은 GitHub뿐만 아니라 다른 코드 호스팅 플랫폼이나 소프트웨어 프로젝트에서도 일반적으로 사용된다.
README의 주요 내용:
- 프로젝트 설명: 프로젝트의 목적, 기능, 주요 특징 등을 설명한다.
- 사용 방법: 프로젝트를 사용하는 방법에 대한 간단한 안내를 제공한다. 이는 설치 방법, 설정, 실행 방법 등을 포함할 수 있다.
- 라이선스: 프로젝트가 사용하는 라이선스에 대한 정보를 제공한다. 이는 프로젝트를 사용할 때의 권리와 제한을 명시하는 중요한 부분이다.
- 설치 방법: 프로젝트를 사용하기 위해 필요한 소프트웨어나 라이브러리의 설치 방법을 안내한다.
- 이 외에도 프로젝트에 대한 팁이나 주의사항, 기여 방법 등을 포함할 수 있다.
README 파일은 프로젝트를 만든 사람뿐만 아니라 직장 동료, 프로그램 사용자 및 잠재적인 기여자들을 위해 존재한다. 이 파일은 프로젝트의 가장 처음에 위치하며, 프로젝트에 대한 이해를 돕고 사용자나 협업자들에게 필요한 정보를 제공한다.
GitHub는 Markdown을 사용하여 README 파일 및 기타 문서를 작성하는 데 많이 사용된다. Markdown은 텍스트 기반의 경량 마크업 언어로, 쉽게 읽고 쓸 수 있으며 HTML로 변환되어 웹페이지에 표시된다.
README.md를 쓰는 방법
1) 프로젝트 클릭
2) README 섹션의 Edit file 버튼 클릭
2. Header (제목)
Header는 #(샾)으로 표현하며, 최대 6개까지 사용할 수 있다.
# 제목 1
## 제목 2
### 제목 3
#### 제목 4
##### 제목 5
###### 제목 6
3. BlockQuote (인용문)
> 이 인용문이다.
> > 인용문 안에 또 인영문 할 수 있다.
4. 숫자 목록
1. 첫번째
2. 두번째
3. 세번째
5. 목록 - 순서없이
*, +, - 로 순서없는 목록을 만들 수 있다.
- 이것
- 저것
6. 코드 블럭
a = 1
b = 2<code> sum = a + b </code>
<pre><code> print(sum) </code><pre>
7. 수평선
***
___
8. 링크
Link1: [Google](https://google.com) #[단어](URL)Link2: <https://python.org>Email: <qwe@gmail.com>
9. 강조
*기울임*_기울임_**굵게**__굵게__~~취소선~~
10. 이미지
1) GitHub 로그인
2) 프로젝트에서 Issues 탭 클릭
3) 오른쪽에 New issue 버튼 클릭
4) 업로드하고 싶은 이미지를 본문으로 드래그
5) 본문 내 생성된 URL 복사
6) < > Code 탭에서 README.md 파일에 붙여넣기
7) i단어
