다음과 같은 구성 요소와 템플릿을 기반으로의 입력을 많은 사람들에 기여 토론을 만들기”추가 정보.txt 템플릿”. 구체화 된 예제를 위해 몇 가지 샘플 텍스트를 사용하고 있습니다. 대부분은 관리 메뉴 모듈의 추가 정보에서 비롯됩니다.txt.
목차
TOCs 는 선택 사항이지만 긴 README 파일에 대해서는 감사합니다.,
소개
소개(필수)로 구성되어야의 간단한 단락 또는 두 가지 요약의 목적과 기능을 이 프로젝트입니다. 이 소개는 프로젝트 페이지의 첫 번째 단락과 같을 수 있습니다.소개에는 프로젝트 페이지 및 문제 대기열에 대한 링크가 포함되어야합니다. 프로젝트가 샌드 박스 인 경우 이러한 링크는 홍보 할 때까지 샌드 박스로 이동해야합니다.
요구사항
섹션에서 요구 사항(필수)하여 분명히 여부는 이 프로젝트가 필요합 이외의 아무것도 Drupal 코어 작업(모듈 라이브러리,etc.)., 다른 모듈 등에서 간접적으로 따르는 요구 사항을 포함하여 여기에 모든 요구 사항을 나열하십시오. 아이디어는 필요한 것을 사용자에게 알리고 필요한 모든 것을 조달하고 모듈을 설치하려고 미리 포함시킬 수 있도록하는 것입니다. 요구 사항이없는 경우”특별한 요구 사항 없음”이라고 작성하십시오.
REQUIREMENTS------------This module requires no modules outside of Drupal core.모듈을 권장
이 선택적 섹션에 나열 모듈은 필요하지 않지만,그 유용성을 향상 시킬 수 있습니다 또는 사용자의 경험 프로젝트입니다. 이러한 모듈을 활성화 할 때의 이점을 설명해야합니다.,
설치
설치 섹션(필수*)은 모듈을 설치하는 방법을 분명히해야합니다. 그러나,경우를 설치하려면 모듈을 따라 표준에 대한 지침 Drupal8,Drupal7,Drupal6/5,또는 테마,바퀴를 재발견하지 마십시오—단순히 링크를 제공하고 설명하는 상세한 모든 단계를 수행할 수 있는 발산에서 이러한 단계입니다. Drush 통합의 특별한 메모를 가져 가라. 많은 Drush 명령이 추가 된 경우 Drush 에 대한 섹션을 추가하는 것을 고려하십시오.
이 섹션을 독립 실행 형 설치로 대체하는 것을 고려하십시오.,설치 지침이 특히 복잡한 경우 txt 파일.
*-별도의 설치하지 않는 한 필요합니다.txt 가 제공됩니다.
Drupal7
Drupal8
구성
configuration section(필수)는 필요한 경우에도 조금 구성이 필요합니다. 사용 권한을 포함하되 이에 국한되지 않음-이 모듈의 구성에 대한 특별한 메모를 나열하려면이 섹션을 사용합니다. 이 섹션은 모듈이 Drupal UI 외부에서 추가 구성이 필요한 경우 특히 중요합니다.,
경우 모듈은 거의 또는 전혀 구성해야 이 공간을 사용하는 방법을 설명하고 활성화/비활성화하 모듈에 영향을 미칠 것이다.
CONFIGURATION------------- * Configure the user permissions in Administration " People " Permissions: - Use the administration pages and help (System module) The top-level administration categories require this permission to be accessible. The administration menu will be empty unless this permission is granted. - Access administration menu Users with this permission will see the administration menu at the top of each page. - Display Drupal links Users with this permission will receive links to drupal.org issue queues for all enabled contributed modules. The issue queue links appear under the administration menu icon. * Customize the menu settings in Administration " Configuration and modules " Administration " Administration menu. * To prevent administrative menu items from appearing twice, you may hide the "Management" menu block.또는
문제를 해결&FAQ
이 섹션들은 선택적입니다. 존재하는 경우 문제 대기열에서 자주 묻는 질문을 해결해야합니다(앞으로 시간을 절약 할 수 있습니다). 개요는 일반적인 문제를 사람들이 따라 발생하는 솔루션으로(링크가 좋아하는 경우 단계는 긴지만,그것은 도움이 되는 경우가 종종 요약을 제공하기 위해 이후 연결 때로는 오래된 가).,
메인테이너들
이 섹션은 선택 사항이며 기존의 독립형 메인테이너들을 대체해야 합니다.txt 파일.
Advanced help
advanced help 가 활성화되어 있으면 화면에 README 파일이 표시됩니다.
에 대한 모든 Markdown
중 Drupal 프로젝트 수명,있는 분명한 합의는 것에 대해 README 파일을 찾아야 한처럼,그리고 많은 다른 스타일로 존재하는 결과(아래 링크 참조). 그러나 우리는 새로운 프로젝트가이 페이지에 설명 된 형식이나 마크 다운 필터 모듈에서 인식 한 형식을 사용하는 것을 선호합니다., 당신이 사용하는 경우 Markdown,당신의 파일을 지정해야합니다.md(고 사용하는 유효한 인문),그렇지 않으면 그것을 지정해야합니다.txt.
빠른 서식 팁
다음은 README 에 대해 선호하는 형식을 요약 한 것입니다.txt:
- 모든 대문자의 제목.
- 제목으로 밑줄이
===/---길이의 제목,followed by a blank line. - 제목 앞의 두 줄(첫 번째 줄 제외).
- 글 머리 기호는 매달린 들여 쓰기가있는 별표(*)로 표시됩니다.
- 번호 매기기 목록 들여 쓰기 4 공백.,
- 글 머리 기호 목록 들여 쓰기 1 공간.
- 텍스트 수동으로 약 80cols 내에서 단어 래핑.
샘플 readme
일부 샘플 README-파일:
- Morbus’README.txt 스타일(Drupal core 의 스타일과 가장 가까운 스타일과 일치).
- 쉬운 빵 부스러기 README.md (이 템플릿을 사용)