안녕하세요 홍 가 입니다.
오늘은 프로젝트 소개글을 적는 README.md 사용법을 알려 드리려고 합니다.
깃허브 Repository에 들어가시면 New라는 초록색 버튼을 클릭
Repository name 부분은 저장소 이름이 되는 부분이에요
이름을 적으신 다음 Create repository를 클릭하시면
이렇게 생성이 되신 걸 보실 수 있으세요
저는 리드미 파일을 만드는 걸 체크해서 바로 README.md가 생성되어있어요
리드미는 프로젝트를 소개하는 부분인데요 작성을 해보려고 해요.
리드미를 작성하는 문법을 살짝 알려드릴게요
파일에서 작업을 하면 Preview로 어떻게 나오는지 확인을 할 수 있어서 매우 편하답니다.
아니면 비쥬얼코드를 사용하시는 분이면 이렇게 할 수 도 있어요
#은 글머리 기호입니다. ##이 늘어나면 글자가 작아져요
보통 #####까지 사용을 하고
제목으로 ## or ###로 많이 사용하고 있어요
소스 코드를 작성하실 때는 ```를 사용하면 됩니다.
```사용할 언어 적기
소스코드 넣기
```
를 하시면 저렇게 나와요
참고 자료 링크를 넣으시려면
[이름] (url주소)를 하면 주소 부분만 하이퍼링크로 들어가고요
[]() 공백이 없으면 이름 부분에 하이퍼링크가 들어갑니다.
목록 만들기를 하시려면
*을 사용해 주시고 저렇게 순서를 맞춰주시면 목록을 만들 수 있어요
테이블을 만들고 싶으시다면 |를 써야 해요
---|는 제목 부분을 만들어 줍니다.
강조는 ** **를 사용하시면 되고 취소선은 ~~ ~~ 입니다
이렇게 프로젝트를 소개하는 리드미 사용 법을 알아봤습니다.
잘 활용하셔서 프로젝트를 간단하게 소개해보세요!
git bash로 git hub 에 커밋하기 (0) | 2023.03.13 |
---|---|
깃허브 Issues, Projects 사용해보기 (0) | 2023.03.02 |
깃허브 팀 프로젝트 Organization 사용법 (0) | 2023.02.17 |
비쥬얼스튜디오코드로 깃허브 파일생성하기 (1) | 2022.09.19 |
깃허브 꾸미기 (0) | 2022.02.14 |