A template to make good README.md

README-Template.md

Project Title（プロジェクト タイトル）

プロジェクトの1段落はここに

Getting Started（導入）

これらの手順では、開発とテストの目的でローカルマシン上でプロジェクトのコピーを作成して実行します。

ライブシステムにプロジェクトを配備する方法については、配備を参照してください。

Prerequisites（前提条件）

ソフトウェアのインストールに必要なものとソフトウェアのインストール方法

Give examples

Installing（インストール）

開発環境を実行するために必要な一連の手順を示す。

ステップがどのようなものかを示す。

Give the example

以下、繰り返し。

until finished

いくつかのデータをシステムから出力したり、小さなデモで使用したりする例を示して章を終了する。

Running the tests（テストの実行）

このシステムの自動化テストを実行する方法を説明する。

Break down into end to end tests（テストの詳細説明）

これらのテストが何をして、なぜそれが必要なのかを説明する。

Give an example

And coding style tests（コーディングスタイルのテスト）

これらのテストが何をして、なぜそれが必要なのかを説明する。

Give an example

Deployment（デプロイ方法）

ライブシステムへのデプロイに関する追加説明を記述する。

Built With（ビルド方法）

使用可能なビルドツールについて記述する。

• Dropwizard - The web framework used
• Maven - Dependency Management
• ROME - Used to generate RSS Feeds

Contributing（コントリビュート）

私たちの行動規範、およびプルリクエストのプロセスについて、CONTRIBUTING.mdを参照してください。

Versioning（バージョン管理）

バージョン管理には SemVer を使用します。利用可能なバージョンについては、このリポジトリのタグを参照してください。

Authors（著者）

• Billie Thompson - 初期作業 - PurpleBooth

このプロジェクトに参加したコントリビュータ達のリストも参照してください。

License（ライセンス）

このプロジェクトはMITライセンスの下でライセンスされています - 詳細はLICENSE.mdファイルを参照してください

Acknowledgments（謝辞）

• コードを使用しているひと
• インスピレーションを与えてくれたもの
• その他