READMEテンプレート

admin

以下のコンポーネントとテンプレートは、”READMEを作成する”という議論に貢献した多くの人の入力に基づいています。txtテンプレート”。 肉付けされた例を持つために、私たちはいくつかのサンプルテキストを使用しています。 そのほとんどは、管理メニューモジュールのREADMEから来ています。テキスト

目次

目次はオプションですが、長いREADMEファイルには高く評価されています。,

はじめに

はじめに（必須）は、このプロジェクトの目的と機能を要約した簡単な段落または二つで構成されなければなりません。 この紹介は、プロジェクトページの最初の段落と同じかもしれません。

導入には、プロジェクトページと課題キューへのリンクが含まれている必要があります。 プロジェクトがsandboxの場合、これらのリンクは昇格までsandboxに移動する必要があります。

Requirements

requirementsセクション（必須）は、このプロジェクトがDrupal core以外のもの（モジュール、ライブラリなど）を動作させる必要があるかどうかを明確にします。, 別のモジュールから間接的に従うものなど、ここにすべての要件をリストします。 アイデアは、モジュールをインストールする前に、必要なものをすべて調達して含めることができるように、ユーザーに必要なものを知らせることです。 要件がない場合は、”特別な要件はありません”と書いてください。

REQUIREMENTS------------This module requires no modules outside of Drupal core.

推奨モジュール

このオプションのセクションでは、必須ではありませんが、プロジェクトの有用性やユーザーエクスペリエンスを向上させる これらのモジュールを有効にする利点を説明してください。,

インストール

インストールセクション(必須*)は、モジュールのインストール方法を明確にするものとします。 ただし、モジュールをインストールする手順がDrupal8、Drupal7、Drupal6/5、またはテーマの標準手順に従っている場合は、ホイールを再発明しないでください。 Drushの統合に特に注意してください。 多くのDrushコマンドが追加される場合は、Drushのセクションを追加することを検討してください。

このセクションをスタンドアロンインストールに置き換えるこ,txtファイルは、インストール手順が特に複雑である場合。

*-別のインストールがない限り必須です。txtが提供されています。

Drupal7

Drupal8

設定

設定セクション(必須)は、ほとんど設定が必要な場合でも必要です。 このセクションを使用して、このモジュールの設定に関する特別なメモを一覧表示します。 このセクションは、モジュールが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ファイル。

高度なヘルプ

高度なヘルプは、READMEファイルが有効になっている場合、画面に表示されます。

Markdownについてのすべて

Drupalプロジェクトの存続期間中、READMEファイルがどのように見えるかについて明確なコンセンサスがなく、結果として多くの異なるスタイルが存在します（以下のリンクを参照）。 しかし、好きのための新たなプロジェクトの形式で記述このページの形式に認めたものMarkdownフィルターモジュールです。, Markdownを使用する場合は、ファイルに名前を付ける必要がありますREADME.md （有効なMarkdown構文を使用してください）、それ以外の場合はREADMEという名前にする必要があります。テキスト

クイックフォーマットのヒント

READMEに推奨されるフォーマットの概要を以下に示します。txt:

  • すべての大文字の見出し。
  • ===/---見出しの長さに下線が引かれ、その後に空白行が続きます。
  • 見出しの前に二行（最初の行を除く）。
  • アスタリスク(*)で示される箇条書きで、インデントがぶら下がっています。
  • 4つのスペースをインデントした番号付きリスト。,
  • 箇条書きリストは、1つのスペースをインデントしました。
  • テキストは約80cols内で手動でワードラップされます。

サンプルreadme

いくつかのサンプルREADMEファイル：

  • MorbusのREADME。txtスタイル（Drupal coreのスタイルに最も近いものと一致します）。
  • 簡単なパンくずリストREADME.md （このテンプレートを使用しています）

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です