읽어주세요

README
2011년 소설은 램드를 참고하세요.2022년 회고록은 README.txt.
cURL의 README 파일 스크린샷

소프트웨어 개발에서 README 파일은 컴퓨터 소프트웨어의 디렉토리 또는 아카이브에 있는 다른 파일에 대한 정보를 포함합니다.문서의 한 형태로, 그것은 보통 다음과 같은 단순한 평문 파일입니다.README,Read Me,READ.ME,README.TXT,[1] README.md(Markdown 사용 표시) 또는README.1ST.[2]

파일 이름은 일반적으로 대문자로 씁니다.특히 유닉스 계열의 시스템에서는 소문자 파일 이름이 더 일반적이고 명령어가 파일을 [nb 1]ASCII 코드 순서로 정렬하여 표시하기 때문에 파일 이름이 먼저 표시됩니다.

내용물

README 파일은 일반적으로 다음을 포함합니다.

역사

README 파일을 포함하는 관례가 언제부터 시작되었는지는 확실하지 않지만 1970년대 중반까지 거슬러 올라가는 예들이 [4][5][6][7][8][9][2][better source needed]발견되었습니다.초기 매킨토시 시스템 소프트웨어는 시동 디스크에 Read Me를 설치했으며 README 파일은 일반적으로 타사 소프트웨어와 함께 제공되었습니다.

특히, 자유 소프트웨어와 오픈 소스 소프트웨어의 오랜 역사가 있으며, 그 중 하나는 [10]"패키지의 전반적인 개요"를 제공하도록 GNU 코딩 표준에서 권장하고 있습니다.

소프트웨어 배포를 위한 사실상의 표준 플랫폼으로서 웹의 출현 이후, 많은 소프트웨어 패키지들은 위의 보조 파일들 및 정보들 중 일부를 웹사이트 또는 위키로 이동(또는 때때로 복사)하였고, 때로는 README 자체를 포함하여,또는 때로는 소프트웨어의 새로운 사용자가 요구하는 모든 정보 없이 간단한 README 파일만 남겨두기도 합니다.

인기 있는 소스 코드 호스팅 웹사이트 GitHub은 README 파일을 생성하는 것을 강력히 권장합니다 – 저장소의 메인(상위) 디렉토리에 파일이 존재할 경우, 자동으로 저장소의 첫 페이지에 표시됩니다.일반 텍스트 외에도 다양한 다른 형식과 파일 확장자를 [11]지원하며 HTML 변환 시 확장자를 고려합니다. 특히 aREADME.mdGitHub 맛 마크다운으로 취급됩니다.

총칭으로

"readme file"이라는 표현은 비슷한 [citation needed]목적을 가진 다른 파일에 대해서도 일반적으로 사용되기도 합니다.예를 들어, 많은 무료 소프트웨어 패키지의 소스 코드 배포판(특히 Gnits Standards를 따르는 배포판이나 GNU Autotools로 제작된 배포판)에는 readme 파일의 표준 집합이 포함되어 있습니다.

README 일반정보
AUTHORS 크레딧
THANKS 답례
CHANGELOG 프로그래머를 위한 상세 변경 로그
NEWS 사용자를 위한 기본 변경 로그
INSTALL 설치설명서
COPYING/LICENSE 저작권 및 라이선스 정보
BUGS 알려진 버그 및 새 버그 보고에 대한 지침
CONTRIBUTING/HACKING 프로젝트의 잠재적 기여자를 위한 가이드

또한 일반적으로 소프트웨어 패키지와 함께 배포되는 것은 FAQ 파일과 a입니다.TODO계획된 개선 사항을 나열하는 파일입니다.

참고 항목

메모들

  1. ^ 더 이상 그렇지 않은 경우가 많지만 LC_ALL=CL은 이전 동작을 보여줍니다.

참고문헌

  1. ^ Raymond, Eric Steven (1996). The New Hacker's Dictionary. MIT Press. pp. 378–79. ISBN 978-0-26268092-9. Hacker's-eye introduction traditionally included in the top-level directory of a Unix source distribution, containing a pointer to more detailed documentation, credits, miscellaneous revision history, notes, etc. […] When asked, hackers invariably relate the README convention to the famous scene in Lewis Carroll's Alice's Adventures In Wonderland in which Alice confronts magic munchies labeled "Eat Me" and "Drink Me".
  2. ^ a b Abdelhafith, Omar (2015-08-13). "README.md: History and Components". Archived from the original on 2020-01-25. Retrieved 2020-01-25.
  3. ^ a b Manes, Stephen (November 1996). "README? Sure--before I buy!". PC World. 14 (11): 366.
  4. ^ "PDP-10 Archive: decus/20-0079/readme.txt from decus_20tap3_198111". pdp-10.trailing-edge.com. 1974-11-27. Retrieved 2018-03-03. [README.TXT is the DOC file for SPICE/SINC/SLIC] This failsafe tape contains the circuit analysis programs SPICE SINC and SLIC described in the Applications Software Bulletin Volume 4. requirements: SPICE requires FORTRAN-10 version 4 because of its use of Right adjusted Holerith data. Executes in about 47K. […] it also includes this file, the FOROTS to go with the SAVes and the source for SECOND.MAC, the timing routine. SPICE is broken into three parts: 1SPICE.FOR, 2 and 3. There is a printed document to describe each of the programs. These are included in the DECUS packet. The documentation and programs were originally developed by the E.E. department of the Univ. of Calif. at Berkeley on a CDC 6400. Except to convert the FORTRAN to the DECsystem-10 no changes have been made to the programs. For the test data SLIC and SINC have shown a slight variation with respect to the 6400, SPICE shows no variation. Good luck! Ashley Grayson 27-NOV-74 [end of README.TXT]
  5. ^ "DECUS 10-LIB-4 Contains 10-210 through 10-241, except 10-223". pdp-10.trailing-edge.com. 1975-03-27. Retrieved 2018-03-03. The files on this FAILSAFE tape constitute the UCI LISP system. They are for the most part documented in the UCI LISP Manual, available from the Department of Information and Computer Science at the University of California, Irvine, California. [1]
  6. ^ "Programmer's Workbench /sys/source/lex/README". July 1977. Retrieved 2020-01-25.
  7. ^ "Unix 7th edition /usr/doc/README". 1979. Retrieved 2020-01-25.
  8. ^ "First 32bit BSD usr/doc/README". March 1980. Retrieved 2020-01-25.
  9. ^ Langemeier, Jeff (2011-07-29). "Re: Origin of README". Retrieved 2020-01-25 – via Stackexchange. […] they had READMEs (actual physical printed files) for all of their punch cards and mag tape and pretty much anything else that was a "program". At that time you really needed one because of the labourous process that was involved with getting the created, ran, and everything else. These READMEs sometimes also included the actual printouts of how the punch cards were supposed to be punched as a form of error checking and debugging. The convention apparently also follows the old system in that with all the punch cards a "reem" of paper was attached with the statement README in caps printed on it, this had all of the instructions for use and loading of the punch cards into the system. For a time reference, this would have been in the 60s. […]
  10. ^ "GNU Coding Standards: Releases". www.gnu.org. Retrieved 2018-03-03.
  11. ^ "Markup". GitHub. 2014-12-25. Retrieved 2015-02-08.

추가열람

이 글은 부분적으로 공용 도메인에 있는 전문가 파일을 기반으로 합니다.