Readme.txt 및 README.txt


33

방금 Github에서 프로젝트를 포크하고 변경했습니다. 이것은 궁금합니다. 오픈 소스 프로젝트에서 주로 README.txt가 보이고 편집 한 파일은 Readme.txt입니다. 이것은 일종의 표준화입니까, 아니면 그대로 두어야합니까?


모든 대문자는 아마도 MS-DOS에서 시작되었을 것입니다. 대문자 인 첫 글자는 확실하지 않습니다. Mac 루트 일 것입니다. 결국, 그것은 단정함이나 스타일의 문제를 제외하고는 중요하지 않습니다.
로렌스

답변:


29

대문자로 된 모든 문자는 눈에 잘 띄고 파일을 쉽게 볼 수있게합니다. 이는 아마도 새로운 사용자가 가장 먼저보고 싶어 할 것이기 때문입니다. (또는 적어도 해야 다른 사람들이 이미 말했듯이, 파일 이름은 대문자로 시작 ... 살펴 보았다)에서 소문자 이름 앞에 표시됩니다 ASCIIbetical 정렬 ( LC_COLLATE=C첫 눈에있는 파일을 볼 수 있도록 도와줍니다).

README파일은 무료 소프트웨어 패키지 사용자가 일반적으로 찾을 것으로 예상되는 많은 파일의 일부입니다. 다른 것은 INSTALL(소프트웨어 구축 및 설치에 대한 지시 사항), AUTHORS(기여자 목록), COPYING(라이센스 텍스트), HACKING(기여하기 시작하는 방법, 시작점의 TODO 목록 포함), NEWS(최근 변경 사항) 또는 ChangeLog(대부분 중복되는 부분) 버전 관리 시스템).

이것이 GNU 코딩 표준README파일 에 대해 말한 것 입니다.

배포판에는 README패키지의 일반적인 개요와 함께 이름이 지정된 파일이 포함되어야합니다 .

  • 패키지 이름;
  • 패키지의 버전 번호 또는 패키지에서 버전을 찾을 수있는 위치를 참조하십시오.
  • 패키지가하는 일에 대한 일반적인 설명;
  • 파일에 대한 참조 : INSTALL설치 절차에 대한 설명이 포함되어야합니다.
  • 특이한 최상위 디렉토리 또는 파일에 대한 간략한 설명 또는 독자가 소스를 둘러 볼 수있는 다른 힌트
  • 복사 조건이 포함 된 파일에 대한 참조 GNU GPL을 사용하는 경우라는 파일에 있어야합니다 COPYING. GNU LGPL을 사용하는 경우라는 파일에 있어야합니다 COPYING.LESSER.

사용자의 놀라움을 최소화하기 위해 항상 노력하는 것이 좋으므로 편차가 발생하는 이유가없는 한이 규칙을 따라야합니다. UNIX 세계에서는 파일 이름 확장자가 전통적으로 드물게 사용되었으므로 파일의 표준 이름에는 README접미사 가 없습니다. 그러나 대부분의 사용자는 아마도 이름 README.txt이 지정된 파일의 의미가 동일하다는 것을 이해하는 데 어려움이 없을 것입니다 . 파일이 Markdown 으로 작성된 경우 와 같은 파일 이름 README.md도 합리적 일 수 있습니다. HTML과 같은 더 복잡한 마크 업 언어를 사용하지 마십시오README그러나 텍스트 전용 터미널에서 읽는 것이 편리해야하기 때문입니다. README파일의 세부 사항을 위해보다 정교한 형식으로 작성 될 수있는 소프트웨어 매뉴얼 또는 온라인 문서를 사용자에게 지시 할 수 있습니다 .


20

알파벳 순서를 사용하는 명령 행 환경은 파일을 맨 위에 놓기 때문에 일반적으로 파일을 대문자로 README라고했습니다. 이를 통해 큰 디렉토리에서 쉽게 볼 수 있습니다.

소스를 다운로드 한 다음 소프트웨어를 빌드 할 유닉스 / 리눅스 세계의 영향을받을 가능성이 높습니다. README 및 INSTALL과 같은 파일을 'list directory contents'보기의 맨 위에두면 명령 행 인터페이스에서 전체 컨텐츠를 찾아 보지 않아도 파일이 있는지 쉽게 확인할 수 있습니다. 동일한 기본 원칙이 github에서도 작동합니다 (실제로 GUI 인터페이스에서도 작동하므로 생각할 수 있으므로 여전히 장점이 있습니다)

결코 어려운 규칙은 아니지만, 다른 프로젝트가하고 있기 때문에 모두가 습관으로하는 일이있을 가능성이 높습니다. 명시적인 이유가없는 한, 다른 많은 프로젝트에서 사용되는 것을 볼 수 있기 때문에 모든 캡을 사용해야합니다. 새 저장소를 만들 때 Github이 사용하는 기본 이름이기도합니다.


나는 항상 대문자로 된 부분이 법률의 대문자 부분을 갖는 것과 마찬가지로 강조의 한 형태라고 생각했습니다.
Lars Viklund

1
명령 행 인터페이스에서 목록의 맨 위로 이동하는 파일은 실제로 가장 먼저 스크롤되지 않은 파일이므로 때때로 가장 적은 파일입니다. 항상 같은 것을하지 않는 한 ls -l | less.
Marc van Leeuwen

6

README는 일반적으로 대문자로 작성됩니다. 이런 식으로 lsUnix 명령은 파일을 디렉토리 목록의 시작 부분 근처에 배치했습니다 (대문자는 ASCII 순서에서 소문자보다 먼저옵니다).


3
이것은 역사적인 이유 였지만 ls현대 시스템에서는 일반적으로 그렇게 분류되지 않습니다.

1
@ dan1111 맞아! 주셔서 감사합니다 (그냥 ... 시도 LC_COLLATE="en_US.ascii" ; ls -lLC_COLLATE="en_US.UTF-8" ; ls -l)
manlio
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.