최근 수정 시각 : 2025-04-02 22:17:54

README


파일:다른 뜻 아이콘.svg   
#!if 넘어옴1 != null
'''리드미'''{{{#!if 넘어옴2 != null
, ''''''}}}{{{#!if 넘어옴3 != null
, ''''''}}}{{{#!if 넘어옴4 != null
, ''''''}}}{{{#!if 넘어옴5 != null
, ''''''}}}{{{#!if 넘어옴6 != null
, ''''''}}}{{{#!if 넘어옴7 != null
, ''''''}}}{{{#!if 넘어옴8 != null
, ''''''}}}{{{#!if 넘어옴9 != null
, ''''''}}}{{{#!if 넘어옴10 != null
, ''''''}}}은(는) 여기로 연결됩니다. 
#!if 설명 == null && 리스트 == null
{{{#!if 설명1 == null
다른 뜻에 대한 내용은 아래 문서를}}}{{{#!if 설명1 != null
{{{#!html 비마니 리듬게임 수록곡}}}에 대한 내용은 [[Lead Me]] 문서{{{#!if (문단1 == null) == (앵커1 == null)
를}}}{{{#!if 문단1 != null & 앵커1 == null
의 [[Lead Me#s-|]]번 문단을}}}{{{#!if 문단1 == null & 앵커1 != null
의 [[Lead Me#|]] 부분을}}}}}}{{{#!if 설명2 != null
, {{{#!html 씨스타의 노래}}}에 대한 내용은 [[Lead Me(노래)]] 문서{{{#!if (문단2 == null) == (앵커2 == null)
를}}}{{{#!if 문단2 != null & 앵커2 == null
의 [[Lead Me(노래)#s-|]]번 문단을}}}{{{#!if 문단2 == null & 앵커2 != null
의 [[Lead Me(노래)#|]] 부분을}}}}}}{{{#!if 설명3 != null
, {{{#!html }}}에 대한 내용은 [[]] 문서{{{#!if (문단3 == null) == (앵커3 == null)
를}}}{{{#!if 문단3 != null & 앵커3 == null
의 [[#s-|]]번 문단을}}}{{{#!if 문단3 == null & 앵커3 != null
의 [[#|]] 부분을}}}}}}{{{#!if 설명4 != null
, {{{#!html }}}에 대한 내용은 [[]] 문서{{{#!if (문단4 == null) == (앵커4 == null)
를}}}{{{#!if 문단4 != null & 앵커4 == null
의 [[#s-|]]번 문단을}}}{{{#!if 문단4 == null & 앵커4 != null
의 [[#|]] 부분을}}}}}}{{{#!if 설명5 != null
, {{{#!html }}}에 대한 내용은 [[]] 문서{{{#!if (문단5 == null) == (앵커5 == null)
를}}}{{{#!if 문단5 != null & 앵커5 == null
의 [[#s-|]]번 문단을}}}{{{#!if 문단5 == null & 앵커5 != null
의 [[#|]] 부분을}}}}}}{{{#!if 설명6 != null
, {{{#!html }}}에 대한 내용은 [[]] 문서{{{#!if (문단6 == null) == (앵커6 == null)
를}}}{{{#!if 문단6 != null & 앵커6 == null
의 [[#s-|]]번 문단을}}}{{{#!if 문단6 == null & 앵커6 != null
의 [[#|]] 부분을}}}}}}{{{#!if 설명7 != null
, {{{#!html }}}에 대한 내용은 [[]] 문서{{{#!if (문단7 == null) == (앵커7 == null)
를}}}{{{#!if 문단7 != null & 앵커7 == null
의 [[#s-|]]번 문단을}}}{{{#!if 문단7 == null & 앵커7 != null
의 [[#|]] 부분을}}}}}}{{{#!if 설명8 != null
, {{{#!html }}}에 대한 내용은 [[]] 문서{{{#!if (문단8 == null) == (앵커8 == null)
를}}}{{{#!if 문단8 != null & 앵커8 == null
의 [[#s-|]]번 문단을}}}{{{#!if 문단8 == null & 앵커8 != null
의 [[#|]] 부분을}}}}}}{{{#!if 설명9 != null
, {{{#!html }}}에 대한 내용은 [[]] 문서{{{#!if (문단9 == null) == (앵커9 == null)
를}}}{{{#!if 문단9 != null & 앵커9 == null
의 [[#s-|]]번 문단을}}}{{{#!if 문단9 == null & 앵커9 != null
의 [[#|]] 부분을}}}}}}{{{#!if 설명10 != null
, {{{#!html }}}에 대한 내용은 [[]] 문서{{{#!if (문단10 == null) == (앵커10 == null)
를}}}{{{#!if 문단10 != null & 앵커10 == null
의 [[#s-|]]번 문단을}}}{{{#!if 문단10 == null & 앵커10 != null
의 [[#|]] 부분을}}}}}}
#!if 설명 == null
{{{#!if 리스트 != null
다른 뜻에 대한 내용은 아래 문서를}}} 참고하십시오.

#!if 리스트 != null
{{{#!if 문서명1 != null
 * {{{#!if 설명1 != null
비마니 리듬게임 수록곡: }}}[[Lead Me]] {{{#!if 문단1 != null & 앵커1 == null
문서의 [[Lead Me#s-|]]번 문단}}}{{{#!if 문단1 == null & 앵커1 != null
문서의 [[Lead Me#|]] 부분}}}}}}{{{#!if 문서명2 != null
 * {{{#!if 설명2 != null
씨스타의 노래: }}}[[Lead Me(노래)]] {{{#!if 문단2 != null & 앵커2 == null
문서의 [[Lead Me(노래)#s-|]]번 문단}}}{{{#!if 문단2 == null & 앵커2 != null
문서의 [[Lead Me(노래)#|]] 부분}}}}}}{{{#!if 문서명3 != null
 * {{{#!if 설명3 != null
: }}}[[]] {{{#!if 문단3 != null & 앵커3 == null
문서의 [[#s-|]]번 문단}}}{{{#!if 문단3 == null & 앵커3 != null
문서의 [[#|]] 부분}}}}}}{{{#!if 문서명4 != null
 * {{{#!if 설명4 != null
: }}}[[]] {{{#!if 문단4 != null & 앵커4 == null
문서의 [[#s-|]]번 문단}}}{{{#!if 문단4 == null & 앵커4 != null
문서의 [[#|]] 부분}}}}}}{{{#!if 문서명5 != null
 * {{{#!if 설명5 != null
: }}}[[]] {{{#!if 문단5 != null & 앵커5 == null
문서의 [[#s-|]]번 문단}}}{{{#!if 문단5 == null & 앵커5 != null
문서의 [[#|]] 부분}}}}}}{{{#!if 문서명6 != null
 * {{{#!if 설명6 != null
: }}}[[]] {{{#!if 문단6 != null & 앵커6 == null
문서의 [[#s-|]]번 문단}}}{{{#!if 문단6 == null & 앵커6 != null
문서의 [[#|]] 부분}}}}}}{{{#!if 문서명7 != null
 * {{{#!if 설명7 != null
: }}}[[]] {{{#!if 문단7 != null & 앵커7 == null
문서의 [[#s-|]]번 문단}}}{{{#!if 문단7 == null & 앵커7 != null
문서의 [[#|]] 부분}}}}}}{{{#!if 문서명8 != null
 * {{{#!if 설명8 != null
: }}}[[]] {{{#!if 문단8 != null & 앵커8 == null
문서의 [[#s-|]]번 문단}}}{{{#!if 문단8 == null & 앵커8 != null
문서의 [[#|]] 부분}}}}}}{{{#!if 문서명9 != null
 * {{{#!if 설명9 != null
: }}}[[]] {{{#!if 문단9 != null & 앵커9 == null
문서의 [[#s-|]]번 문단}}}{{{#!if 문단9 == null & 앵커9 != null
문서의 [[#|]] 부분}}}}}}{{{#!if 문서명10 != null
 * {{{#!if 설명10 != null
: }}}[[]] {{{#!if 문단10 != null & 앵커10 == null
문서의 [[#s-|]]번 문단}}}{{{#!if 문단10 == null & 앵커10 != null
문서의 [[#|]] 부분}}}}}}
Linux kernel
============

There are several guides for kernel developers and users. These guides can
be rendered in a number of formats, like HTML and PDF. Please read
Documentation/admin-guide/README.rst first.

In order to build the documentation, use ``make htmldocs`` or
``make pdfdocs``. The formatted documentation can also be read online at:
https://www.kernel.org/doc/html/latest/

There are various text files in the Documentation/ subdirectory,
several of them using the reStructuredText markup notation.

Please read the Documentation/process/changes.rst file, as it contains the
requirements for building and running the kernel, and information about
the problems which may result by upgrading your kernel.
Linux 커널의 README
길게 설명하지 않고 핵심만 요약한 짧은 내용이 특징이다.#
1. 개요2. 내용 및 구성3. 형식4. 기타5. 관련 문서

1. 개요

소프트웨어를 개발 또는 배포할 때, 개발자가 해당 프로그램의 소스 또는 실행 파일들을 보는 사람들을 위해 만들어 둔 문서, 설명서, 또는 그러한 내용을 담은 파일을 말한다.

관련 지식이 없는 사용자가 해당 파일부터 먼저 읽게 만들기 위해 '날 읽어(read me)'라고 지시하는 파일명이 특징으로, 파일명 규칙에 따라 공백이 없고 전부 대문자로 쓰는 것이 일반적인데, 이는 대문자가 아스키 코드상 소문자보다 위쪽에 정렬되고 소문자보다 강조 효과가 있기 때문이다.[1]

2. 내용 및 구성

목적상 크게 다른 팀원 및 외부 개발자들을 위한 용도인지, 엔드 유저를 위한 용도인지로 나뉜다. 전자의 경우 주로 소스에서 빌드하는 방법(build-from-source), 개발환경 구축 절차 등이 나열되어 있고 후자의 경우 라이선스, 설치 방법, 사용 방법 등이 들어가게 된다. 오픈소스 프로그램의 경우 이 두 성격이 혼재되어 나타나는 경우도 존재한다.

주로 다음 내용들이 순서대로 들어가는 편이다.
  • 제목
  • 프로젝트 로고, 트레이드 마크, 회사 로고, 사진, 구동 스크린샷 등 - 텍스트 형식이 아니라 기타 마크업 형식일 때 주로 사용된다.
  • 프로젝트 소개
  • 개발환경 구축 절차, 요구 종속성, 요구 운영체제 및 아키텍처 사양, 요구 하드웨어 사양 등
  • 소스 다운로드 방법, 저장소 클론 방법, 체크아웃 방법, 패치 방법 등 - 소스 용량이 너무 크거나 저작권 등의 문제로 한번에 다운받을 수 없을 경우, 여러 개의 미러(mirror) 서버가 운영되는 경우, 또는 원본 소스에 특정한 패치(patch)를 적용해야 하는 경우, 해당 방법을 설명한다.
  • 빌드/컴파일 방법
  • 설치 방법
  • 사용 방법, 각종 예제, 튜토리얼 등
  • 설정 방법, 개별 옵션, 플래그 용도 및 사용법 등 - man page나 --help 출력을 그대로 가져다 둔 경우도 많다.
  • 기여 방법, 프로젝트 컨벤션, 코딩 스타일
  • TODO, 미구현 기능 목록, 향후 릴리즈 및 기능 추가 계획 등
  • 변경사항, 릴리즈 정보
  • FAQ, 자주 묻는 질문
  • 라이선스, 저작권 고지
  • 개발자 명단, 크레딧, 개발자 연락처, 회사 문의 방법 등
  • Special Thanks - 주로 오픈 소스 프로젝트에서 자주 보이는 내용으로, 종속성으로 사용된 라이브러리 개발자를 향한 감사, 주요 기여자에 대한 감사 등이 들어간다.

3. 형식

초창기에는 TXT 등 무형식 텍스트 파일을 주로 사용했다. 이 경우 UNIX의 전통에 따라 확장자를 쓰지 않는 경우도 흔하다. 반면에 NT 계열에서는 파일 시스템상 README.txt 형식의 파일명이 더 보편적이다.

2000년대 이후 GitHub 등 웹 UI 기반의 플랫폼이 등장함에 따라 적절한 렌더러를 갖춘 환경에서 마크업 언어로 작성되는 경우도 등장하기 시작했다.

일반적으로 자주 쓰이는 확장자와 파일 포맷은 다음과 같다.

4. 기타

가끔씩 랜섬웨어에 걸렸을 때 암호화가 된 구역에 이러한 이름의 파일을 생성시키기도 한다. 따라서 이를 통해 해당 컴퓨터가 얼마나 암호화가 퍼졌는지를 알 수 있다.

5. 관련 문서

[1] On Unix-like systems in particular, this causes it to stand out – both because lowercase filenames are more common, and because the ls command commonly sorts and displays files in ASCII-code order, in which uppercase filenames will appear first.

분류