728x90
깃허브는 공개된 장소입니다. 누구나 인터넷만 연결되어 있으면 구경할 수 있습니다.
하지만 방대한 코드와 컨트리뷰션 그래프(기여도 그래프)만 살펴보는 것으로는
이 저장소가 왜 있고 어떤 용도 인지 알기 힘듭니다.
그렇기에 README 파일을 만들어서 이 저장소를 어떻게 사용했고 어떻게 사용하는지 알려줍니다.
<Readme 파일 예시>
README 파일 만들기
깃허브에서 새로운 레파지토리를 만들고 왼쪽 밑에 [Add a README]를 누릅니다.
README 파일에서는 실제 줄 바꿈을 2번 해야 실제 보이는 창에서 줄이 바뀐다.
Preview 를 통해서 수정된 내용을 볼 수 있다.
다 작성한 후 밑에 Commit changes 를 통해서 바꿀 수 있다.
Preview changes 를 누르면 README 파일이 수정된 내역을 확인 할 수 있다.
빨간색은 삭제된 부분이고, 초록색은 추가된 내용이다.
마크다운 문법으로 README 파일 편집하기
제목
# 마크다운 제목
## 마크다운 제목
### 마크다운 제목
#### 마크다운 제목
가로 줄
---
----------
- - -
***
*********
* * *
텍스트 강조
**Github** 는 좋은 협업 도구입니다.
인용
>인용할 말은 >를 통해서 인용할 수 있습니다.
>> 인용 속 인용은 >를 한번 더 써주면 됩니다.
소스 코드
소스코드 1줄은 1번 왼쪽 그레이브을 통해서
`Source`
```
여러줄 코드는
`를 3번써서 사용 가능합니다.
```
링크
<www.naver.com>
[네이버](www.naver.com)
[네이버](www.naver.com, "네이버 링크 설명")
이미지
![대체 텍스트](이미지 url)
순서 없는 목록
+ 순
+ 서
+ 없
- 목록속 목록
+ 는
+ 목
+ 록
+ / - / * 중 하나를 통해서 목록을 만들 수 있다. 반드시 + / - / * 을 사용후 한 칸 띄어야 한다.
순서 있는 목록
1. 순서1
2. 순서2
3. 순서3
숫자. 과 내용은 반드시 한 칸 띄어야 인식한다.
728x90
'Programming > Github & git' 카테고리의 다른 글
[Github] 오픈소스 참여하기 (0) | 2020.05.11 |
---|---|
[Github] 깃허브에 이미지 올리기 및 README에서 이미지 사용하기 (0) | 2020.05.11 |
[Github] 협업에서 브랜치 사용하기 (0) | 2020.05.10 |
[Github] 깃허브를 통한 협업 (0) | 2020.05.10 |
[Github] 원격 브랜치 정보 가져오기 (0) | 2020.05.09 |