레파지토리에 프로젝트등이 올라가 있다면 아래에 설명문이 있는 것을 볼 수 있다.
오픈소스 저장소를 설명해주는 리드미의 작성은 중요하다.
생성하는 방법은 여러가지인데,
레파지토리 생성시에 'Add a README file'에 체크하거나
레파지토리 생성 후에 'Add a README'버튼을 클릭하거나
상단 Add file의 Create new file을 클릭해서
README.md파일을 생성해주면 된다.
만약 하위 디렉토리를 생성하고 안에 리드미를 만들어주고 싶다면,
파일 생성창에 디렉토리 이름 작성 후, '/'를 쳐주면 위와 같이 새로운 디렉토리 생성과
그 디렉토리에 리드미가 생성된다.
이제 리드미를 생성했으면 작성을 한다.
주로 사용하는 것들 위주로 정리했다.
#은 제목이고 수가 많아질 수록 소제목에 가까워진다.
*,+,-는 목록이다.
>는 인용블럭이 생성되고
***는 구분선,
```(코드)```는 코드 블럭이 생성되는데, `는 따옴표가 아닌 ~버튼에 있는 기호다.
위와 같이 작성하면 이렇게 나온다.
더 많은 마크다운 작성법은 아래에 잘 정리되어 있다.
마크다운(Markdown) 사용법
마크다운(Markdown) 사용법. GitHub Gist: instantly share code, notes, and snippets.
gist.github.com
리드미에 이미지를 넣고 싶다면
상단 이슈탭에서 new issue를 눌러준 뒤
이미지를 드래그 앤 드랍해주거나 복붙해넣으면 링크가 나오는데
이 링크를 리드미에 그대로 넣어주면 이미지를 넣을 수 있다.
'git' 카테고리의 다른 글
| [Github] 깃허브 꾸미기, 깃 프로필, 백준 깃허브 연동 (0) | 2022.04.01 |
|---|---|
| [Github] 깃헙, Git, 깃 사용법, 레파지토리 생성 (0) | 2022.03.31 |