읽어보기란 무엇입니까? README는 전체 코드베이스가 수행하는 작업이 아닌 경우 일반적으로 일부를 강조 표시하는 일련의 지침, 정보 및/또는 가이드입니다. README는 HTML 구문 외에 익숙한 것과 다를 수 있는 Markdown 구문으로 작성됩니다.

그렇다면 README를 사용하는 이유는 무엇입니까? 글쎄, 내가 README를 작성하고 시간을 들여 미세 조정하기 시작한 이유는 단순히 내 코드에 액세스할 수 있기 때문입니다. 내 코드나 기술 스택에 익숙하지 않은 사람들이 내 파일 구조, 데이터베이스 관리/스키마 등의 작업에 대한 빠른 통찰력을 얻을 수 있는 가이드를 만듭니다.

이제 좋은 README를 어떻게 작성합니까?

제목, 간단한 설명 및 이미지

먼저 제목이 필요하며 적용 범위에 따라 README 제목을 지정하는 것이 좋습니다. 리포지토리를 열자마자 보게 되는 README의 제목은 리포지토리 또는 제품의 이름이어야 합니다. 이 목적을 위해 h1 태그를 추천합니다. 제품 또는 코드의 전반적인 목적에 대한 짧은 설명(한 문장)을 여기에 넣는 것도 의미가 있습니다. 또한 코드/제품을 나타내는 README 바로 아래에 있는 그림을 추천합니다. 이것은 제품의 로고가 될 수도 있습니다! 주요 기능의 사진이나 작동 중인 제품의 gif일 수 있습니다. 이미지는 img 태그를 사용하여 마크다운 구문으로 작성됩니다. 중요한 참고 사항은 마크다운 구문이 사물, 색상, 크기 등을 배치하기 위해 인라인 스타일을 사용한다는 것입니다. 따라서 이미지의 경우 일반적으로 이미지의 소스(src)를 파일에 링크되거나 저장된 위치에 하이퍼링크로 표시합니다.

내 첫 번째 제목, 설명 및 이미지 중 하나는 아래 예를 참조하십시오.

목차

따라서 프로젝트/제품에 대한 통찰력을 제공하는 멋진 제목, 짧은 설명 및 이미지가 있습니다. 다른 README를 구별하는 다음 항목은 목차라고 생각합니다. Markdown으로 어떻게 목차를 만드나요? 목차에 h2 태그를 붙인 후 다음 형식을 사용하십시오.

별표 다음에 내용의 제목을 감싸는 닫힌 대괄호와 내용이 있는 README 부분에 대한 링크를 묶는 괄호가 옵니다.



예시:

section 1

section 2

section 3

섹션

목차 다음에는 자연스럽게 내용이 따라옵니다. 내용은 프로젝트/제품에 따라 다르지만 내용을 읽기 쉽게 만드는 것은 그림 예제와 코드 스니펫입니다!

코드 조각은 어떻게 작성하고 무엇입니까? 한 번 보자!



세 개의 눈금 표시 뒤에 언어가 있고 눈금 표시 안에 코드 블록을 배치할 수 있습니다. 그런 다음 세 개의 눈금 표시로 닫습니다!

function addTwo(num){
    return num + 2;
}

이것이 제가 README의 기본 사항이라고 생각하는 것입니다. 나중에 이것을 확장하고 싶습니다. 또한 전문가용 제품을 살펴보고 해당 제품의 README를 공부하는 것이 도움이 되었다고 말할 것입니다. 도움이 되었기를 바랍니다. 다음 포스트에서 만나요.