簡単な説明：README.mdファイルをより涼しくするための参照、マークダウン、アイコン。
##📌索引
READMEについて | ロゴタイプとバナー | プロジェクトの名前 | 説明と動機 | バッジ | ビジュアル | テクノロジー | インストール | 使用方法 | プロジェクトステータス | 貢献 | 作者と謝辞 ライセンス
プロジェクトはそれぞれ異なるため、これらのセクションのどれがあなたのプロジェクトに当てはまるかを検討してください。 テンプレートで使用されるセクションは、ほとんどのオープンソースプロジェクトの提案です。 また、READMEは長すぎて詳細になる可能性がありますが、長すぎると短すぎるよりも優れていることに注意してください。 READMEが長すぎると思われる場合は、情報を削除するのではなく、別の形式のドキュメントを利用することを検討してください。
Markdownは、テキストからHTMLへの変換ツールです。 シンプルで読みやすく、書きやすいテキストを使用して書き込み、それが有効なHTMLに変換されます。
MarkdownはJohn GruberとAaron Swartzによって作成され、それらのソースコードはPerlで書かれました。 これは公式ウェブサイトです[ここ]https://daringfireball.net/projects/markdown/）
拡張機能を追加することで、VS Code内でMarkDownインデックスを表示および作成できます。
| ショートカット| 機能| |：---------- | ------ | | cmd-k vまたはctrl-k | プレビューをサイドに開く| | cmd-shift-vまたはctrl-shift-v | プレビューを開く|
さらに、次のようなサイトによるテーブルの作成：
プロジェクトのわかりやすい名前を選択します。
あなたのプロジェクトが具体的に何ができるかを人々に知らせてください。 コンテキストを提供し、訪問者がなじみのない参照へのリンクを追加します。 機能のリストまたは背景のサブセクションもここに追加できます。 プロジェクトに代案がある場合、これは差別化要因をリストするのに適した場所です。
一部のREADMEでは、すべてのテストがプロジェクトに合格したかどうかなど、メタデータを伝える小さな画像が表示される場合があります。 シールドを使用して、READMEにいくつかを追加できます。 多くのサービスには、バッジを追加するための指示もあります。 ……ビジュアル 作成している内容に応じて、スクリーンショットまたはビデオを含めることをお勧めします（実際のビデオではなくGIFが頻繁に表示されます）。 ttygifのようなツールが役立ちますが、より洗練された方法についてはAsciinemaをチェックしてください。
特定のエコシステム内では、Yarn、NuGet、Homebrewなどの一般的なインストール方法が存在する場合があります。 ただし、READMEを読んでいる人が初心者であり、より多くのガイダンスが必要である可能性を考慮してください。 特定の手順をリストすると、あいまいさがなくなり、人々がプロジェクトをできるだけ早く使用できるようになります。 特定のプログラミング言語バージョンやオペレーティングシステムなどの特定のコンテキストでのみ実行される場合、または手動でインストールする必要がある依存関係がある場合は、要件サブセクションも追加します。
自由に例を使用し、可能であれば予想される出力を示します。 READMEに合理的に含めるには長すぎる場合は、より洗練された例へのリンクを提供しながら、実証できる最小の使用例をインライン化すると便利です。 サポート 助けを求めてどこに行くことができるかを人々に伝えます。 課題トラッカー、チャットルーム、メールアドレスなどの任意の組み合わせを使用できます。
プロジェクトのエネルギーや時間が足りなくなった場合は、READMEの先頭に、開発が遅くなった、または完全に停止したことをメモしてください。 誰かがあなたのプロジェクトをフォークするか、ボランティアがメンテナまたは所有者として参加することを選択し、プロジェクトを続行できるようにします。 メンテナに明示的なリクエストをすることもできます。
将来のリリースに関するアイデアがある場合は、READMEにリストすることをお勧めします。 貢献する 寄付を受け入れるかどうか、および寄付を受け入れるための要件は何かを説明します。 プロジェクトに変更を加えたい場合は、開始方法に関するドキュメントを用意しておくと役立ちます。 おそらく、ユーザーが実行する必要のあるスクリプト、またはユーザーが設定する必要のあるいくつかの環境変数があります。 これらの手順を明確にします。 これらの指示は、将来の自分にとっても役立つかもしれません。 コマンドを文書化して、コードを糸くずしたり、テストを実行したりすることもできます。 これらの手順は、高いコード品質を保証し、変更が誤って何かを壊す可能性を減らすのに役立ちます。 ブラウザでテストするためにSeleniumサーバーを起動するなど、外部設定が必要な場合は、テストを実行するための指示があると特に役立ちます。
プロジェクトに貢献してくれた人々に感謝の意を表します。
Status: Required
-
MarkDown
-
Badges
-
Guias
オープンソースプロジェクトの場合は、どのようにライセンスされているかを説明してください。