power-girl0-0

[GIT] Git에서 소개글(README.md) 파일 작성하기 본문

개발

[GIT] Git에서 소개글(README.md) 파일 작성하기

power-girl0-0 2021. 2. 17. 21:59
728x90

 

해당 게시물은 나동빈 님의 'Git으로 시작하는 협업 및 오픈소스 프로젝트'강의를 바탕으로 작성된 것입니다.

스스로 공부한 것을 정리하고 복습하기 위한 목적으로 작성하였습니다.


깃(Git) 프로젝트에서는 README.md 파일을 이용해 소개글을 작성할 수 있다.

md는 마크 다운(Markdown)의 약자이며 최근 굉장히 다양한 분야에서 사용되고 있는 텍스트 양식이다.

매우 빠르게 핵심적인 내용을 작성하는 편집 양식이라는 점에서 깃 허브(Git Hub) 또한 공식적으로 이를 채택하고 있다.


 Git 저장소에서 README.md 파일 생성 

Add a README 버튼을 클릭하면 쉽게 생성이 가능하다.


아래와 같이 README.md 파일을 작성하여 간단히 샵(#)을 붙여 글머리를 작성해 보자.

#은 글머리를 작성할 때 사용하는 것이다.

일반적으로, #은 5개까지 사용이 가능하다.


Preview를 클릭하면, 위에서 작성한 글이 어떻게 보이는지 확인할 수 있다.


Create README.md 라고 커밋 메시지 입력 후, 버튼을 눌러 파일을 올려준다.


아래와 같이, 소개글 형태로 README.md파일이 올라간 것을 확인할 수 있다.


수정을 하려면, 글에 들어가서 아래와 같은 연필모양을 누르면 수정이 가능하다.


위의 내용을 로컬 컴퓨터에도 저장하고 싶으면, git pull 명령어를 사용하면 된다.


 기능 

 소스코드 

소스코드 블록은 다음과 같이 작성할 수 있다.

```c

#include <stdio.h>

 

int main(void) {

  printf("Hello World!");

}

```


 링크 

링크는 다음과 같이 작성할 수 있다.

[블로그 주소](power-girl0-0.tistory.com/)

즉, [ ]에 이름을 적고 ()에 주소를 적으면 된다.

여기서 주의할 점은 []와 ()사이에 공백이 있으면 안된다.


 순서 없는 목록 

순서 없는 목록은 *을 사용하면 되며, 아래와 같이 작성할 수 있다.

   * 깃 강좌

     * 깃 Clone

     * 깃 Pull

     * 깃 Commit

       * 깃 Commit ①

       * 깃 Commit ②

     * 깃 Push


인용

인용 구문은 >를 사용하고, 아래와 같이 작성할 수 있다.

  > 'git공부 화이팅!!' -김도현-


테이블

테이블은 다음과 같이 작성할 수 있다.

   이름|영어|정보|수학
    ---|---|---|---|
   김도현|98점|87점|100점|
   나동빈|97점|78점|93점|
   이순신|89점|93점|97점|


강조

강조는 다음과 같이 할 수 있다.

**은 진하게, ~~은 취소선을 나타낸다.

  **치킨** 먹다가 ~~두드러기~~났어요. ㅠㅠ

 

 

 

 

 



728x90
Comments