061_github - kotaproj/study_zenpan GitHub Wiki

Readme.mdの書き方

参考サイト

ひな形

English version

# Awesome-name

OverviewOverviewOverview

## Description

DescriptionDescriptionDescription
DescriptionDescriptionDescription
DescriptionDescriptionDescription

***DEMO:***

![Demo](https://image-url.gif)

## Features

- Awesome function
- Awesome UI
- ...

For more information, see `awesome-tool --help`.

## Requirement

- Requirement
- Requirement
- Requirement

## Usage

1. Usage
2. Usage
3. Usage

## Installation

$ git clone https://github.com/TomoakiTANAKA/awesome-tool $ cd awesome-tool $ sh setup.sh $ ~~do anything~~


## Test

1. test
2. test
3. test

## Deploy

1. deploy
2. deploy
3. deploy

## Anything Else

AnythingAnythingAnything
AnythingAnythingAnything
AnythingAnythingAnything

## Author

[@TanakanoAnchan](https://twitter.com/TanakanoAnchan)
mail to: [email protected]

## License

[MIT](http://TomoakiTANAKA.mit-license.org)</blockquote>

日本語版

# ツール・ライブラリの名前

概要概要概要概要概要概要概要概要概要概要概要概要概要概要概要概要

## 簡単な説明

簡単な説明簡単な説明簡単な説明簡単な説明簡単な説明簡単な説明簡単な説明
簡単な説明簡単な説明簡単な説明簡単な説明簡単な説明簡単な説明簡単な説明
簡単な説明簡単な説明簡単な説明簡単な説明簡単な説明簡単な説明簡単な説明
簡単な説明簡単な説明簡単な説明簡単な説明簡単な説明簡単な説明簡単な説明

***デモ***

![デモ](https://image-url.gif)

## 機能

- 機能1（UI/計算 etc ...）
- 機能2
- 機能3
- ...

他の機能はこちらを参照して下さい。`awesome-tool --help`.

## 必要要件

- 要件
- 要件
- 要件
- ...

## 使い方

1. 使い方
2. 使い方
3. 使い方

## インストール

$ git clone https://github.com/TomoakiTANAKA/awesome-tool $ cd awesome-tool $ sh setup.sh $ ~~do anything~~


## テスト

1. 使い方
2. 使い方
3. 使い方

## デプロイ

1. デプロイ
2. デプロイ
3. デプロイ

## その他

その他その他その他その他
その他その他その他その他
その他その他その他その他
その他その他その他その他

## 作者

[@TanakanoAnchan](https://twitter.com/TanakanoAnchan)
mail to: [email protected]

## ライセンス

[MIT](http://TomoakiTANAKA.mit-license.org)</blockquote>

最初にアイキャッチ画像などを表示

# リポジトリ名
このソフトはどんなもので、何ができるのかを書く
合わせて、簡単なデモ（使用例）などスクリーンショットやGIFアニメで表示

## Dependency
使用言語とバージョン、必要なライブラリとそのバージョンを書く
Pythonならrequirements.txtを用意するのも良い

## Setup
セットアップ方法を書く。用意するハードウェアとソフトウェアをセットアップするためのコマンドを記載する

## Usage
使い方。なるべく具体的に書く。サンプルも書く

## License
This software is released under the MIT License, see LICENSE.

## Authors
作者を明示する。特に、他者が作成したコードを利用する場合は、そのコードのライセンスに従った上で、リポジトリのそれぞれのコードのオリジナルの作者が誰か分かるように明示する（私はそれが良いと思い自主的にしています）。

## References
参考にした情報源（サイト・論文）などの情報、リンク