New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

READMEを追加する #3

Closed

KATO-Hiro opened this issue Sep 9, 2020 · 1 comment

Contributor

KATO-Hiro commented Sep 9, 2020 •

edited

Loading

WHY

ライブラリを利用する人たち（開発・保守メンバーを含む）に向けて、使いかたなどの説明があったほうがいいと思われるため

WHAT

READMEを記述する言語

英語のみ
日本語のみ
英語と日本語を別ページで用意する

READMEに記述する内容の候補

リポジトリ名
概要とDEMO
対応しているライブラリの一覧と進捗状況
使い方
FAQ
開発・実行環境
- ライブラリの利用者が必要なもの
- ライブラリの開発・保守メンバーが必要なもの
リポジトリへの貢献方法
連絡先
参考資料や関連プロジェクトへのリンク
ライセンスへのリンク

質問

リポジトリのREADMEには、こちらのレポジトリのように英語と日本語を別ページで用意するという形がいいように思いますが、どのようにお考えでしょうか?
READMEの内容として、不足しているもの・冗長なものがあれば、教えていただけますでしょうか?

KATO-Hiro referenced this issue in KATO-Hiro/ac-library-python


          [WIP] Add README (#3)

0f01e0c

KATO-Hiro referenced this issue in KATO-Hiro/ac-library-python


          Update README (#3)

e53929f

not522 added a commit that referenced this issue


          Merge pull request #4 from KATO-Hiro/document/readme

9c5085b

Add README (#3)

Owner

not522 commented Sep 19, 2020

Closed by #4.

not522 closed this as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment