README와 마크다운

** github의 기능으로, 특정 repository에서 

> 프로젝트 설명

> 사용방법

> 라이센스

> 설치법 등에 대해서 기술 

> 본인과 직장동료, 프로그램 사용자를 위해 존재

 

** README 와 Markup 

> github 에서 readme 파일 수정 ( 연필 클릭 ) 

 

 

** Headers : 큰 제목, 작은 제목  

> ========= 

> ------------

 

** 다른 방법으로는 # 을 붙이기 

 

** 가로줄 ( 수평선 )

 

** BlockQuote : 블럭 인용문자 사용 , 블럭들이 하위 브라켓으로 진행하면 상위 버전으로 표기해도 복귀하지 않음 

>

>>

 

** 순서가 있는 목록 ( 1. \n 2. \n 3. .... )  , 자동으로 번호가 매겨짐 

** 순서가 없는 목록 ( * , + , - 로 표시 ) , 탭 두번씩 눌러서 들여쓰기 하면 fill 됨 

 

** 코드 블럭 <pre><code>{코드입력}</code></pre>

** 코드 블럭 ```{코드입력}```

 

** 외부 링크 삽입 \ 문자 삽입  LINK: [텍스트](https주소, 링크 설명 )

 

** 외부 링크 삽입 \ 바로 주소 하이퍼링크 : <https주소>

 

** 문자 모양 ( 볼드 , 이탤릭, 줄긋기 )  

> *를 맨앞에 삽입 후 , 문자모양옆에 바로 글자를 써주면 된다 , 마지막에 문자로 닫아줘서 범위를 제어할 수 있다 

 

** 이미지 삽입 

** 이미지 삽입 야매 : 깃헙으로 변환한 이미지 링크 복붙  !!!!

> github 저장소에서 issues > new issues 클릭. 

> issue 정보 부분에 이미지를 드래그 해서 markdown 링크를 생성한다. 

> 해당 링크를 위 마크다운에 복붙해서 넣는다 ( save 하지 않고 링크만 복사해도 된다 ). 

 

*** 이미지 삽입 -> 마크다운에 바로 이미지를 끌고와도 적용된다 

 

** 터미널에서 markdown 작성하기 

> remote repository에서 pull 해온 local repository로 이동 cd

> git pull origin main 으로 pull 다시 해온다 ( github에 수정중인 것을 사용하려면 ). 

> ls -all 을 해보면 README.md 파일이 있을 것이다

> cat README.md 로 확인해본다 ( 변경됨 )

> 편집기 README.md 로 수정할 수 있다 

- vi README.md

- code README.md

 

> 이후 :wq! 로 write and quit 

> commit 하는 과정은 다른 방법들과 같다 

> git add , git status , git push origin man , 이후 Github 페이지에서 확인