README 파일이란 무엇입니까?

readme 파일은 소프트웨어에 대한 일반적인 정보 나 지침이 포함 된 소프트웨어에 종종 포함되는 텍스트 파일입니다. 이 정보의 특정 특성은 파일마다 크게 다릅니다. 추가 정보 파일에는 설치 지침, 일반 소프트웨어 사용 정보, 서비스 약관 및 기타 법적 정보 또는 소프트웨어와 관련된 기타 정보가 포함될 수 있습니다. 거의 모든 readme 파일에는 최소한 소프트웨어의 이름과 버전, 소프트웨어를 개발 한 회사 또는 개인의 이름, 출판 날짜가 포함됩니다. 그러나 readme를 작성하기위한 일반적인 공식은 없으며 결국 내용은 개발자의 변덕에 달려 있습니다.

"readme"라는 이름은 소프트웨어를 올바르게 작동하는 데 필요한 정보를 포함하기 때문에 파일에 대한 사용자의주의를 끌기위한 것입니다. 대부분의 경우 readme 파일의 파일 이름은 대문자로 표시되며 "README.txt"또는 이와 유사한 이름이됩니다. 일부 프로그램 디렉토리는 대문자 파일 이름을 모든 파일 목록의 맨 위로 이동하므로 대문자는 readme 파일을 두드러지게하고 프로그램을 사용하기 전에 소프트웨어 사용자가 파일을 읽도록 권장합니다. 일부 readme 파일은 실제로 "먼저 읽어주십시오"라는 제목 또는 소프트웨어를 실행하기 전에 독자가 설명서를 살펴 보도록 독려하기위한 유사한 이름입니다.

readme 파일에는 다양한 중요 정보가 포함되어 있습니다. readme 파일에는 일반적으로 포함 된 이름 및 파일 버전 이외에도 시간이 지남에 따라 소프트웨어에 대한 변경 사항을 나열하는 버전 기록 또는 변경 로그가 포함됩니다. 추가 정보에는 소프트웨어 사용에 영향을주는 알려진 문제 또는 버그 목록이 포함될 수도 있습니다. 일부는 개발 팀의 승인 또는 개인 메시지와 같은 덜 중요한 정보를 포함합니다. 특히 간단한 프로그램의 경우, readme 파일은 실제로 소프트웨어의 전체 사용에 관한 지침을 제공하는 사용자 매뉴얼 역할을 할 수 있습니다.

개발자는 일반적으로 간단하고 명확하며 간결한 방식으로 필요한 정보를 배치하는 것을 선호하기 때문에 정교한 readme 파일은 매우 드 rare니다. readme 파일은 일반적으로 개발자가보다 정교한 무언가가 필요하다고 느끼지 않는 한 표준 글꼴과 이미지가없는 일반 텍스트 형식으로 제공됩니다. 이 단순성은 불필요한 방해 요소를 제거하고 독자가 정보에 계속 집중하도록합니다. 추가 정보 파일이 "자주 묻는 질문"또는 FAQ 형식으로 제공되는 경우가 있습니다. 이러한 형식으로 개발자는 사람들이 소프트웨어에 대해 가질 수있는 가장 일반적인 질문을 예측하고 사람들이 읽을 수없는 텍스트 블록에 모든 기술 정보를 배치하는 대신 명확하고 간단한 답변을 제공합니다.