Help us understand the problem. What is going on with this article?

GitHubのREADMEをサクッと高品質で書けるサービス作ってみました。

みなさんは GitHub でオープソースソフトウェア(OSS)を開発して公開する時、README をどのように書いているでしょうか?

GitHub が自動で作ってくれる README に含まれるのはタイトルだけですし、OSS 開発初心者の場合、そもそも README に何を含めるべきかわからないという方もいらっしゃるのではないでしょうか?OSS 開発に慣れている方でも、コードを書くのはいいけれど README を書くのは面倒だと思ったことはありませんか?今回はそんな README 難民の方々向けの Web サービスを作ってみました。

LEADYOU - README Generator

Web サイトへ🐈
top.png

使い方

使い方は簡単です。トップページで GitHub の Public リポジトリの URL を入力してNext Stepボタンを押すと、README に書くべき内容ごとにフィールドが設けられたフォームページに飛ぶので、そこで必要事項を入力するだけです。しかも、トップページでAuto Fillのチェックボックスに ✓ を入れると、リポジトリから取得可能な情報を自動で収集してある程度フォームを埋めてくれます!フォームページの右側には、README のプレビューがあるのでそこで実際の体裁を確認できます(ここの CSS は GitHub の利用している CSS を参考にしているので実際の体裁に遜色ないと思われます)。フォームを埋めることができましたら、フォーム下にあるGenerateボタンを押せば README.md と画像リソースなどがまとまった zip ファイルがダウンロードされますので、お好きな方法でリポジトリにマージしてもらえれば反映されます。

first-step.png

second-step.png

オススメポイント

  1. 書くべき項目が決まっているので何を書けばいいか迷わない
  2. フォーム形式で項目別に入力できるのでわかりやすい
  3. Auto Fillをオンにすればある程度の情報を勝手に埋めてくれる(バッジとか貢献者とか)
  4. 開発者がパット見てちゃんとしてそうと思える体裁の README を書ける
  5. 再現性のある README を書ける
  6. デモ画像の挿入が楽

開発に関わった人

OSS に興味がある方も、すでに公開している方も是非使ってみてください!そして使用感などコメントくだされば幸いです ☺️

追記

LEADYOU のアップデート情報を呟く Twitter アカウントを用意しました(@hacknock_info)。
みなさまの意見を元に順次アップデートしていく予定ですのでご活用いただけると嬉しいです。

Kyome
趣味でmacOS アプリを開発しています RunCatを作った人です 可愛いは正義
https://kyome.io
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした