리드미
"오늘의AI위키"의 AI를 통해 더욱 풍부하고 폭넓은 지식 경험을 누리세요.
1. 개요
리드미 파일은 소프트웨어, 프로젝트 또는 기타 배포물에 대한 정보를 담고 있는 텍스트 파일이다. 일반적으로 설정, 설치, 사용 설명, 저작권 및 라이선스 정보, 연락처 정보, 버그 목록, 문제 해결 지침 등을 포함하며, 1970년대 중반부터 사용되어 왔다. 파일 이름은 README, README.TXT, README.1ST 등 다양하게 사용되며, 깃허브와 같은 소스 코드 호스팅 서비스에서는 프로젝트 설명으로 활용되기도 한다. 리드미 파일은 텍스트 편집기나 전용 도구를 사용하여 작성할 수 있으며, 통합 개발 환경이나 GNU 오토툴과 같은 프레임워크에서 자동 생성되기도 한다.
더 읽어볼만한 페이지
- 파일 이름 - 긴 파일 이름
긴 파일 이름은 FAT 파일 시스템에서 긴 파일 이름을 지원하기 위해 사용되는 기술이며, 마이크로소프트는 VFAT 규칙을 통해 호환성을 확보하고 윈도우 95에서 처음 LFN을 도입했다. - 파일 이름 - 8.3 파일 이름
8.3 파일 이름은 도스 운영체제에서 파일 이름을 8자 본문과 3자 확장자로 제한한 규칙으로, 기술적 제약 극복과 파일 시스템 단순성 유지를 위해 도입되었으며 윈도우에서도 호환성을 위해 지원되고 NTFS에서도 레거시 응용 프로그램과의 호환성을 위해 사용된다. - 소프트웨어 문서화 - GNU 자유 문서 사용 허가서
GNU 자유 문서 사용 허가서는 자유 소프트웨어 재단에서 만든 카피레프트 라이선스로, 문서 저작물의 자유로운 사용, 수정, 배포를 보장하지만, 2차 저작물에도 동일한 라이선스를 적용하고 원저작자 표시 등의 조건을 요구하며, GPL과의 비호환성 등으로 비판받기도 한다. - 소프트웨어 문서화 - 마이크로소프트 독스
마이크로소프트 독스는 마이크로소프트의 기술 문서 웹사이트로, 제품 및 기술별, 작업 단계별 콘텐츠 구성과 오픈 소스 방식 관리를 통해 사용자 참여를 유도하며, MSDN 및 TechNet 라이브러리 콘텐츠를 이전하여 2016년 6월에 공개되었다. - 컴퓨터 파일 - 전자 문서
전자 문서는 19세기 전신 기술에서 시작되어 컴퓨터 기술 발전과 함께 발전해 온, 정보를 전자적인 형태로 기록한 문서를 의미하며, 파일 포맷 비호환성 등의 과제 해결 노력과 함께 대한민국에서는 법적 효력을 인정받고 신뢰성을 높이는 제도들이 시행되고 있다. - 컴퓨터 파일 - 긴 파일 이름
긴 파일 이름은 FAT 파일 시스템에서 긴 파일 이름을 지원하기 위해 사용되는 기술이며, 마이크로소프트는 VFAT 규칙을 통해 호환성을 확보하고 윈도우 95에서 처음 LFN을 도입했다.
| 리드미 |
|---|
2. 내용
리드미 파일은 소프트웨어 배포 시 함께 제공되는 중요한 문서로, 사용자가 소프트웨어를 이해하고 사용하는 데 필요한 다양한 정보를 담고 있다. 일반적으로 설정 및 설치 지침, 사용 설명, 파일 목록(매니페스트), 저작권 및 라이선스 정보, 개발자 연락처, 알려진 버그 목록, 문제 해결 지침, 크레딧 및 감사, 변경 로그, 사용자 대상 뉴스 등이 포함될 수 있다.
리드미 파일에 담기는 정보의 상세 수준은 다양하다. 어떤 파일은 배포물에 관한 거의 모든 정보를 상세하게 기술하는 반면, 어떤 파일은 필수적인 정보만 간략하게 제공하고 갱신 이력, 설치 방법, 라이선스 등의 세부 정보는 별도의 파일로 안내하기도 한다.
2. 1. 일반적인 정보
리드미 파일은 소프트웨어나 프로젝트에 대한 중요한 정보를 담고 있으며, 일반적으로 다음과 같은 내용을 포함한다. 리드미 파일의 상세 수준은 배포물에 관한 모든 정보를 담은 것부터, 필수 정보만 기재하고 나머지 세부 사항(갱신 이력, 설치 방법, 라이선스 등)은 별도 파일로 안내하는 간략한 형태까지 다양하다.- 소프트웨어/프로젝트 정보:
- 이름
- 버전
- 간단한 설명 및 개요
- 기술 정보:
- 파일 구성: 디렉토리나 아카이브의 파일 목록 (매니페스트)
- 동작 환경 및 설정 지침
- 설치 지침 및 간단한 사용 설명
- 개발 및 지원 정보:
- 저작권 및 라이선스 정보
- 배포자 또는 작성자의 연락처 정보
- 크레딧 및 감사
- 변경 로그 (갱신 이력): 주로 동료 프로그래머를 대상으로 한다.
- 알려진 버그 목록
- 문제 해결 지침
- 기타 정보:
- 뉴스 섹션: 주로 최종 사용자를 대상으로 한다.
- (셰어웨어의 경우) 레지스트리 키 획득 방법, 사용 기간 중의 제한 사항 등
2. 2. 설치 및 사용
리드미 파일에는 소프트웨어의 설치와 사용에 필요한 다양한 정보가 포함되는 경우가 많다. 사용자는 리드미 파일을 통해 소프트웨어를 올바르게 설치하고 활용하는 데 도움을 받을 수 있다. 일반적으로 포함되는 설치 및 사용 관련 내용은 다음과 같다.- 기본 정보:
- 소프트웨어의 이름과 버전
- 소프트웨어에 대한 간략한 설명
- 배포된 파일 목록 (파일 매니페스트)
- 소프트웨어 실행에 필요한 동작 환경 (예: 운영체제, 하드웨어 요구 사항 등)
- 설치 및 설정:
- 설치 방법 및 절차
- 설정 관련 지침
- 사용법:
- 기본적인 사용 설명 및 안내
- 최종 사용자를 위한 새로운 기능이나 변경 사항 안내 (뉴스 섹션)
- 문제 발생 시:
- 알려진 버그나 문제점 목록
- 문제 해결 방법 안내
- 추가 정보:
- 변경 로그: 주로 개발자를 대상으로 소프트웨어 변경 이력을 상세히 기록
- 셰어웨어의 경우: 정식 등록 방법, 사용 기간이나 기능 제한에 대한 정보
2. 3. 저작권 및 라이선스
README 파일에는 해당 소프트웨어의 저작권 정보와 라이선스 정보가 포함되는 경우가 많다. 이를 통해 사용자는 소프트웨어의 사용 범위, 수정 및 재배포 가능 여부 등 라이선스 조건을 확인할 수 있다. 또한, 소프트웨어 배포자나 작성자의 연락처 정보가 기재되어 있어, 문의 사항이나 피드백 전달이 필요할 경우 참고할 수 있다.2. 4. 문제 해결
리드미 파일에는 사용자가 소프트웨어를 사용하면서 겪을 수 있는 문제들에 대한 정보가 포함되기도 한다. 여기에는 일반적으로 알려진 버그 목록이나 문제 해결 지침 등이 포함될 수 있다. 이러한 정보는 사용자가 예상치 못한 문제에 직면했을 때 스스로 해결책을 찾는 데 도움을 준다.2. 5. 기타 정보
리드미 파일에는 소프트웨어 개발 및 사용과 관련된 다양한 부가 정보가 포함되기도 한다.- 크레딧 및 감사: 소프트웨어 개발에 기여한 사람이나 도움을 준 이들에 대한 감사의 내용을 담는다.
- 변경 로그: 소프트웨어 버전별 변경 사항을 기록한 목록이다. 주로 개발자들이 참고하며, '갱신 이력'이라고도 한다.
- 뉴스: 소프트웨어와 관련된 새로운 소식이나 공지 사항을 최종 사용자에게 전달하는 역할을 한다.
- 알려진 버그 및 문제점: 현재 소프트웨어에 존재하는 알려진 버그나 문제점 목록을 제공하여 사용자가 인지하도록 돕는다.
- 문제 해결 지침: 사용 중 발생할 수 있는 문제에 대한 해결 방법을 안내한다.
리드미 파일은 이처럼 배포물에 관한 모든 정보를 상세히 담기도 하고, 때로는 기본적인 정보만 제공하고 세부 사항(갱신 이력, 설치 방법, 라이선스 등)은 별도 파일로 안내하는 간략한 형태를 취하기도 한다.
3. 역사
README 파일을 포함하는 관례는 1970년대 중반부터 시작되었다. 초창기 매킨토시 시스템 소프트웨어는 시동 디스크에 Read Me 파일을 설치했으며, README 파일은 일반적으로 타사 소프트웨어와 함께 제공되었다.
특히, 자유 소프트웨어와 오픈 소스 소프트웨어 분야에서는 README 파일을 포함하는 오랜 역사가 있다. GNU 코딩 표준은 "패키지에 대한 일반적인 개요"를 제공하기 위해 README 파일을 포함하도록 권장한다.
월드 와이드 웹이 사실상 표준 소프트웨어 배포 플랫폼으로 자리 잡은 이후, 많은 소프트웨어 패키지들은 README 파일에 담겼던 보조 파일이나 정보의 일부를 웹사이트 또는 위키로 옮기거나 복사하는 경향을 보였다. 때로는 README 파일 자체를 웹사이트 등에 포함시키기도 하고, 때로는 소프트웨어의 새로운 사용자가 필요로 하는 모든 정보가 담겨 있지 않은 짧은 README 파일만 남겨두기도 한다.
인기 있는 소스 코드 호스팅 웹사이트인 깃허브는 저장소의 최상위 디렉토리에 README 파일이 있으면 해당 파일을 저장소의 첫 페이지에 자동으로 표시하도록 적극 권장한다.[1] 일반 텍스트 외에도 다양한 형식과 파일 확장자를 지원하며, 파일 확장자를 고려하여 HTML로 변환한다. 특히 README.md 파일은 깃허브 플래버드 마크다운 형식으로 처리된다.
4. 파일 이름
리드미 파일의 이름은 단순히 'README'로 시작하거나, 텍스트 파일의 확장자를 붙인 'README.TXT', 가장 먼저 읽어야 한다는 의미의 'README.1ST', 또는 'READ.ME'처럼 나누어 쓰는 등 다양하게 사용된다. 과거 마이크로소프트 워드(Microsoft Word)가 널리 쓰이기 전에는 문서 파일임을 나타내는 'README.DOC'라는 이름도 자주 사용되었다.
일본어로 배포되는 소프트웨어에서는 "읽어 주세요", "처음 읽어 주세요"와 같은 일본어 파일명을 사용하기도 한다.
라이브러리나 플러그인과 같이 하나의 디렉터리 안에 여러 소프트웨어와 리드미 파일이 함께 있을 수 있는 경우, 다른 파일과 이름이 겹치지 않도록 각 소프트웨어의 고유한 이름을 사용하여 명명하기도 한다. 예를 들어, 'HOGE.DLL' 파일에 대응하여 'HOGE.TXT'나 'HOGE_README.TXT' 등으로 짓는 방식이다.
파일 이름의 대문자와 소문자 사용법은 특별히 통일된 규칙 없이 다양하게 사용되는 경향이 있다.
4. 1. 일반적인 명명 규칙
"리드미 파일"이라는 표현은 비슷한 목적으로 사용되는 다른 파일들을 지칭하는 일반적인 용어로도 사용된다. 예를 들어, 많은 자유 소프트웨어 패키지(특히 Gnits 표준을 따르거나 GNU 오토툴로 제작된)의 소스 코드 배포판에는 리드미 파일 외에도 다음과 같은 표준 파일 세트가 포함되는 경우가 많다.| 파일명 | 내용 |
|---|---|
README | 일반 정보 |
AUTHORS | 만든 사람들 (크레딧) |
THANKS | 감사 인사 |
CHANGELOG | 프로그래머를 위한 상세 변경 기록 |
NEWS | 사용자를 위한 주요 변경 사항 알림 |
INSTALL | 설치 방법 안내 |
COPYING LICENSE | 저작권 및 라이선스 정보 |
BUGS | 알려진 버그 및 버그 신고 방법 안내 |
CONTRIBUTING HACKING | 프로젝트 기여 방법 안내 |
이 외에도 소프트웨어 패키지와 함께 자주 배포되는 파일로는 FAQ 파일이나 개선해야 할 점을 나열하는 TODO 파일 등이 있다.
리드미 파일 자체의 이름은 단순히 "README"로 시작하여, 일반적인 텍스트 파일의 확장자를 붙인 "README.TXT", 가장 먼저 읽어야 한다는 의미를 강조한 "README.1ST", 또는 "README"를 나누어 쓴 "READ.ME" 등 다양하게 사용된다. 과거 마이크로소프트 워드(Microsoft Word)가 널리 쓰이기 전에는 문서 파일임을 나타내기 위해 "README.DOC"라는 이름도 자주 사용되었다.
일본어로 배포되는 소프트웨어의 경우, "읽어 주세요", "처음 읽어 주세요", "읽어줘" 와 같이 일본어 파일명을 사용하는 경우도 있다.
라이브러리나 플러그인처럼 하나의 디렉터리 안에 여러 소프트웨어와 각각의 리드미 파일이 함께 있을 가능성이 높은 경우에는, 다른 소프트웨어 파일과 이름이 겹치지 않도록 각 소프트웨어의 고유한 이름을 사용하여 명명하기도 한다. 예를 들어, "HOGE.DLL"이라는 배포 파일에 대응하여 리드미 파일 이름을 "HOGE.TXT"나 "HOGE_README.TXT" 등으로 짓는 식이다.
또한, 파일명의 대문자와 소문자 사용법은 특별히 통일된 규칙 없이 다양하게 사용되는 경향이 있다.
4. 2. 유닉스 계열 시스템
유닉스 계열 운영체제 환경, 특히 오픈 소스 소프트웨어 패키지에서는 `README` 파일 외에도 프로젝트에 대한 다양한 정보를 제공하는 표준적인 파일들을 함께 배포하는 경우가 많다. 이러한 관행은 Gnits 표준을 따르거나 GNU 오토툴을 사용하여 빌드 시스템을 구성한 프로젝트에서 두드러지며, 다른 많은 프로젝트에서도 널리 통용되는 관례이다.이 파일들은 일반적으로 파일명을 대문자로 작성하여 다른 소스 코드 파일과 쉽게 구별되도록 한다. 주요 파일들과 그 내용은 다음과 같다.
| 파일명 | 설명 |
|---|---|
README | 프로젝트에 대한 기본적인 일반 정보 |
AUTHORS | 소프트웨어 개발에 참여한 작성자 및 기여자 목록 (크레딧) |
THANKS | 프로젝트에 도움을 준 사람이나 단체에 대한 감사 표시 |
CHANGELOG 또는 ChangeLog | 주로 개발자를 대상으로 한 상세한 변경 이력 (변경 로그) |
NEWS | 주로 최종 사용자를 대상으로 한 주요 변경 사항 및 새로운 기능 요약 |
INSTALL | 소프트웨어 설치 방법 안내 |
COPYING 또는 LICENSE | 저작권 정보 및 소프트웨어 라이선스 정보 |
BUGS | 알려진 버그 목록 및 새로운 버그를 보고하는 방법에 대한 안내 |
CONTRIBUTING 또는 HACKING | 프로젝트에 기여하고자 하는 개발자를 위한 안내 사항 |
이 외에도 자주 묻는 질문과 답변을 모아놓은 FAQ 파일이나, 앞으로 추가하거나 개선해야 할 기능 목록을 담은 `TODO` 파일이 함께 배포되기도 한다.
GitHub와 같은 코드 호스팅 및 협업 플랫폼에서는 프로젝트의 루트 디렉토리에 있는 `README` 파일의 내용을 자동으로 웹 페이지 형식으로 변환하여 보여주는 기능을 제공한다. 이는 유닉스 문화에서 비롯된 `README` 파일의 중요성과 정보 제공 관례가 현대 개발 환경에서도 이어지고 있음을 보여준다.
4. 3. 깃허브(GitHub)
깃허브와 같은 인기 있는 소스 코드 호스팅 웹사이트는 저장소의 최상위(루트) 디렉토리에 README 파일이 있으면, 이를 해당 프로젝트의 설명으로 간주하여 저장소의 첫 페이지에 자동으로 표시하는 것을 적극 권장한다.[1] 이는 UNIX 문화에서 README 파일을 사용하는 관례를 기반으로 만들어진 편리한 기능이다.깃허브는 일반 텍스트뿐만 아니라 다양한 형식과 파일 확장자를 가진 README 파일을 지원하며, 파일 확장자에 따라 내용을 HTML로 변환하여 보여준다. 특히, `README.md` 파일은 깃허브 플래버드 마크다운 형식으로 처리되어 웹 페이지에 표시된다.
5. 작성 방법
README 파일은 텍스트 편집기를 사용하여 직접 작성할 수 있다. 또는, 필요한 항목을 입력하면 정해진 형식의 텍스트 파일을 만들어주는 리드미 작성 전용 도구를 사용할 수도 있다. 통합 개발 환경(IDE)이나 GNU 오토툴스와 같은 개발 프레임워크 중에는 README 파일을 포함한 첨부 문서를 자동으로 생성해주는 기능을 갖춘 경우도 많다.
6. 기타 이용
참조
[1]
웹사이트
About READMEs
https://docs.github.[...]
2024-05-31
[2]
저널
README? Sure--before I buy!
[3]
웹인용
Read_me 2.3 Report
http://www.m-cult.or[...]
[4]
웹인용
Read_Me 2.3 press-release short
http://www.m-cult.or[...]
[5]
웹인용
readme - Slate Magazine
http://www.slate.com[...]
2012-06-25
[6]
웹인용
Michael Kinsley, Correctionaholic
http://www.cjr.org/r[...]
2012-06-25
[7]
웹인용
About - readmecmu
http://readmecmu.wor[...]
2012-06-25
본 사이트는 AI가 위키백과와 뉴스 기사,정부 간행물,학술 논문등을 바탕으로 정보를 가공하여 제공하는 백과사전형 서비스입니다.
모든 문서는 AI에 의해 자동 생성되며, CC BY-SA 4.0 라이선스에 따라 이용할 수 있습니다.
하지만, 위키백과나 뉴스 기사 자체에 오류, 부정확한 정보, 또는 가짜 뉴스가 포함될 수 있으며, AI는 이러한 내용을 완벽하게 걸러내지 못할 수 있습니다.
따라서 제공되는 정보에 일부 오류나 편향이 있을 수 있으므로, 중요한 정보는 반드시 다른 출처를 통해 교차 검증하시기 바랍니다.
문의하기 : help@durumis.com