📝 README生成
生成結果
プロジェクト名・説明・インストールコマンド・使い方・ライセンスを入力するだけで、一般的な構成のREADME.md雛形をMarkdown形式で生成するツールです。新しいリポジトリを作成したときの叩き台として活用できます。
使い方
- プロジェクト名と簡単な説明を入力します。
- インストールコマンドと使い方のコマンドを入力します。
- ライセンスを選択すると、README.mdの雛形が自動的に生成されます。コピーボタンでクリップボードにコピーできます。
よくある質問
生成されたREADMEをそのまま使えますか?
基本的な構成の雛形として使えますが、実際のプロジェクトに合わせて機能一覧や貢献方法(Contributing)、スクリーンショットなどのセクションを追加することをおすすめします。
ライセンスの本文まで生成されますか?
いいえ、ライセンス名を明記した短い文章のみを生成します。実際のライセンス全文が必要な場合は、選択したライセンスに応じたLICENSEファイルを別途プロジェクトに追加してください。
英語のREADMEにしたい場合は?
各入力欄の内容を英語で入力すれば、そのまま英語のREADMEとして生成されます(見出し部分は現在の表示言語に従います)。