良い README.md を書くためのテンプレート（翻訳）

GitHub Gist で[Billie Thompson さん](https://gist.github.com/PurpleBooth) が公開している [良い README.md を書くためのテンプレート | A template to make good README.md](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2) という Gist が良さそうだったので日本語に翻訳しました。

このマークダウン文書は、オープンソースプロジェクトの README.md をテンプレート化したもので、プロジェクトの概要説明から開発環境の立ち上げ、貢献方法への案内などを簡潔にまとめる方法が書かれています。オープンソースのライブラリを公開するときなどにコピーして使うと良さそうです。

翻訳は見出し・パラグラフ・リスト等ごとに原文と日本語文を併記する形にしました。誤字や翻訳の間違いなどがあると思いますので、編集リクエスト歓迎です。

---

# Project Title / プロジェクトのタイトル

One Paragraph of project description goes here
プロジェクトの概要を 1 段落でここに書きます

## Getting Started / スタートガイド

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
プロジェクトを複製してローカル端末で実行し、開発や検証ができるまでの手順を説明します。実際のシステムにプロジェクトをデプロイする方法については、デプロイの項目を参照してください。

### Prerequisites / 必要条件

What things you need to install the software and how to install them
プロジェクトを走らせるためにはどんなソフトウェアが必要で、それらをどのようにインストールするか

```
Give examples
コマンドで例を示します
```

### Installing / インストール

A step by step series of examples that tell you how to get a development env running
動作する開発環境の構築方法を段階的に例示します

Say what the step will be
手順はこんな感じ

```
Give the example
コマンドで例を示します
```

And repeat
それから

```
until finished
終わるまでのコマンドの例を繰り返します
```

End with an example of getting some data out of the system or using it for a little demo
このシステムが出力するデータの例とか、あるいはちょっとしたデモを示して終わります

## Running the tests / テストの実行

Explain how to run the automated tests for this system
自動テストをどのように実行するかをここで説明します

### Break down into end to end tests / e2e テストまで詳解する場合

Explain what these tests test and why
何のためのテストでどうしてそれを行うのかを説明します

```
Give an example
コマンドで例を示します
```

### And coding style tests / それからコーディングスタイルのテスト

Explain what these tests test and why
何のためのテストでどうしてそれを行うのかを説明します

```
Give an example
コマンドで例を示します
```

## Deployment / デプロイ

Add additional notes about how to deploy this on a live system
実際のシステムにデプロイするための補足的な説明を行います

## Built With / 協働するシステムのリスト

- [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used / 使用した web フレームワーク
- [Maven](https://maven.apache.org/) - Dependency Management / 依存関係管理ソフトウェア
- [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds / 使用した RSS フィード生成

## Contributing / コントリビューション

Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
私たちのコーディング規範とプルリクエストの手順についての詳細は[CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) を参照してください。

## Versioning / バージョン管理

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
私たちはバージョン管理に [SemVer](http://semver.org/)を使用しています。利用可能なバージョンは[このリポジトリのタグ](https://github.com/your/project/tags)を参照してください。

## Authors / 著者

- **Billie Thompson** - _Initial work / 原著者_ - [PurpleBooth](https://github.com/PurpleBooth)

See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
このプロジェクトへの[貢献者](<(https://github.com/your/project/contributors)>)のリストもご覧ください。

## License / ライセンス

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
このプロジェクトは MIT ライセンスの元にライセンスされています。 詳細は[LICENSE.md](LICENSE.md)をご覧ください。

## Acknowledgments / 謝辞

- Hat tip to anyone whose code was used / コードを書いた人への感謝
- Inspiration / 何からインスピレーションを得たか
- etc / その他