README 쓰기: 1부
README? 어디서 많이 보던 건데
문서는 길게 쓰지 않으셔도 됩니다. 간단한 메모처럼 남겨 주셔도 됩니다.
README란
GitHub의 저장소에서 README.md라는 파일을 발견하신 적 있으실 겁니다. 저장소 페이지에 들어가면 소스 파일 목록 아래에 주욱 펼쳐지는게 바로 이 파일입니다. 여기에 저장소에 대한 간략한 설명을 써 놓곤 합니다. GitHub에서 새 저장소를 만들 때에 기본으로 만들 수도 있습니다.
마크다운?
README.md 파일의 이름을 볼까요. README는 읽어죠네요. 맨 뒤에 붙은 md는 마크다운(MarkDown)의 줄임말입니다. 마크다운은 HTML과 같은 마크업 언어 중 하나입니다.
마크업 언어의 개념은 이미 익숙하실 것입니다. 굵은 글씨를 나타내려면 <b>HTML로는 이렇게</b>그리고**MarkDown으로는 이렇게** 하면 됩니다.
한 번 마크다운으로 제목과 내용을 써 볼까요.
위처럼 쓰면 아래처럼 보입니다.
샵을 붙이면 제목이 되고그냥 쓰면 그냥 내용이 됩니다.
축하드립니다. 마크다운을 터득하셨습니다. 이제 README.md에 문서를 작성하실 준비가 되었습니다. 2부로 넘어갑니다.
물론 마크다운 없이도 README.txt에 내용을 작성하실 수 있습니다. 다만 마크다운으로 작성한 문서가 시각적으로 정돈되어 보기 편하기 때문에 문서를 작성하는 의미를 살릴 수 있습니다.
Last updated