방금 Github에서 프로젝트를 포크하고 변경을했습니다. 이로 인해 궁금증이 생겼습니다. 대부분 README가 보입니다. 오픈 소스 프로젝트의 txt이고 내가 편집 한 파일은 Readme.txt입니다. 이것은 일종의 표준화입니까, 아니면 그대로 두어야합니까?
설명
- 모든 대문자는 MS-DOS에서 시작되었을 것입니다. 모두 소문자는 아마도 유닉스 유산에서 나온 것입니다. 대문자로 된 첫 글자가 확실하지 않습니다. 아마도 Mac 뿌리 일 것입니다. 결국에는 깔끔함이나 스타일을 제외하고는 '별로 중요하지 않습니다.
답변
모두 대문자가 눈에 띄고 파일을 쉽게 볼 수있게 해주는데, 이는 아마도 새로운 사용자가보고 싶어하는 첫 번째 항목이기 때문입니다. (또는 적어도 봤어야합니다 …) 다른 사람들이 이미 말했듯이 ASCIIbetical 정렬 (LC_COLLATE=C)은 파일을 한 눈에 볼 수 있도록합니다.
README 파일은 자유 소프트웨어 패키지 사용자가 일반적으로 찾을 것으로 예상되는 파일 묶음의 일부입니다. 기타는 INSTALL (소프트웨어 빌드 및 설치 지침), AUTHORS (참여자 목록), COPYING (라이선스 텍스트), HACKING (기여 시작 방법, TODO 시작점 목록 포함), NEWS (최근 변경 사항) 또는 ChangeLog (대부분 버전 관리 시스템과 중복 됨)
GNU 코딩 표준 은 README 파일에 대해 설명해야합니다.
배포판에는 패키지의 일반적인 개요와 함께
README라는 파일이 포함되어야합니다.
- 패키지 이름;
- 패키지의 버전 번호 또는 패키지에서 버전을 찾을 수있는 위치 참조
- 패키지가 수행하는 작업에 대한 일반적인 설명
- 파일에 대한 참조
INSTALL. n에는 설치 절차에 대한 설명이 포함되어 있습니다.- 비정상적인 최상위 디렉토리 나 파일에 대한 간략한 설명 또는 독자가 소스를 탐색하는 데 도움이되는 기타 힌트
- a 복사 조건을 포함하는 파일 참조. GNU GPL이 사용되는 경우
COPYING라는 파일에 있어야합니다. GNU LGPL을 사용하는 경우COPYING.LESSER라는 파일에 있어야합니다.
사용자의 놀라움을 최소화하기 위해 항상 노력하는 것이 좋기 때문에 편차에 대한 설득력있는 이유가없는 한이 규칙을 따라야합니다. UNIX 세계에서 파일 이름 확장자는 전통적으로 드물게 사용되었으므로 파일의 표준 이름은 접미사없이 README입니다. 그러나 대부분의 사용자는 README.txt라는 파일이 동일한 의미를 가지고 있다는 사실을 이해하는 데 어려움이 없을 것입니다. 파일이 마크 다운 으로 작성된 경우 README.md와 같은 파일 이름도 합리적입니다. 그러나 README 파일에서 HTML과 같은 더 복잡한 마크 업 언어를 사용하지 마십시오. 텍스트 전용 터미널에서 읽는 것이 편리해야하기 때문입니다. README 파일의 세부 사항에 대해 사용자에게 소프트웨어 설명서 또는보다 정교한 형식으로 작성된 온라인 문서를 안내 할 수 있습니다.
답변
전통적으로 파일은 알파벳 순서를 사용하는 명령 줄 환경에서 파일을 맨 위에 놓기 때문에 대문자로 README라고 불 렸습니다. 이렇게하면 큰 디렉터리에서 쉽게 볼 수 있습니다.
소스를 다운로드 한 다음 소프트웨어를 빌드하는 유닉스 / 리눅스 세계로부터의 유보 일 가능성이 높습니다. “목록 디렉토리 내용”보기 상단에 README 및 INSTALL과 같은 파일이 있으면 명령 줄 인터페이스에서 전체 내용을 찾아 볼 필요없이 그들이 거기에 있다는 것을 더 쉽게 알 수 있습니다. 동일한 기본 원칙이 github에서도 작동합니다 (실제로 GUI 인터페이스에서도 작동합니다. 여전히 장점이 있습니다.)
절대로 어려운 규칙은 아니지만 다른 프로젝트에서 수행하고 있기 때문에 모두가 습관으로하는 행동 일 가능성이 높습니다. 그렇게하지 않는 명시적인 이유가없는 한 모든 다른 많은 프로젝트에서 그렇게 사용되는 것을 볼 수 있기 때문입니다. 새 저장소를 만들 때 Github에서 사용하는 기본 이름이기도합니다.
댓글
- I ' 항상 모두 대문자가 강조의 한 형태라고 생각했습니다. 율법에서 대문자 섹션을 사용하는 것과 비슷합니다.
- 명령 줄 인터페이스에서 목록의 맨 위로 이동하는 파일은 실제로보기에서 먼저 스크롤되는 파일이므로 가장 적게 보이는 파일 일 수 있습니다. 항상
ls -l | less와 같은 작업을 수행하지 않는 한.
답변
README는 일반적으로 대문자로 작성됩니다. 이런 식으로 ls Unix 명령은 디렉토리 목록의 시작 부분 근처에 파일을 배치했습니다 (ASCII 순서에서 대문자는 소문자 앞에옵니다).
댓글
- 역사적인 이유 였지만
ls는 ' 일반적으로 최신 시스템에서는 그런 방식으로 정렬합니다. - @ dan1111 맞아요! 감사합니다. 시도해보세요 …
LC_COLLATE="en_US.ascii" ; ls -l대LC_COLLATE="en_US.UTF-8" ; ls -l)