概要 — README ジェネレーター の機能
この無料ツールについて
無料 README ジェネレーターは、短いフォームから完璧なGitHub README.mdを構築します。テンプレート(Minimal、Standard、Library、Web App)を選択し、プロジェクト名、説明、作者、インストールコマンド、使用コードを入力すれば、数秒で洗練されたREADMEが完成します。バッジ、ライセンス、コントリビューティングセクション、テストセクションはすべてワンクリックで切り替えられます。
プライバシー: このツールはブラウザ内で完全に動作します。テキストはアップロード、記録、キャッシュされません。タブを閉じれば消えます。DevTools → Network で確認できます:リクエストはゼロです。
なぜ無料なのか(そしてどう維持しているのか)
良いREADMEは、人々が使うオープンソースプロジェクトと忘れ去られるプロジェクトの違いを生みます。すべてのフリーツール、すべてのインディーライブラリ、すべてのサイドプロジェクトにまともなREADMEを持ってほしい。だからこそ永久に無料です。
使用方法一覧
早見リファレンス
| 入力 | 出力 | 一般的なサイズ | 速度 | ログインの要否 |
|---|
| Form fields | README.md (GitHub-ready) | Any project | Real-time | No |
README ジェネレーター の機能
この無料ツールの詳細 — すべての機能は実際の問題を解決するために作られ、ブラウザ内で完結し、永久に無料です。
4つのプロジェクトテンプレート
プロジェクトに合ったテンプレートを選択できます:Minimal(タイトル+説明+ライセンス、小さなユーティリティライブラリ向け)、Standard(機能と使用法セクション追加、一般的なオープンソースプロジェクト向け)、Library(関数シグネチャ付きAPIセクション追加、再利用可能なライブラリ向け)、Web App(リポジトリクローン+開発サーバー手順付きGetting Startedセクション追加)。各テンプレートが適切なセクションを事前に入力するため、空のファイルを前にして悩む必要がありません。
READMEテキストが完成したら、無料 Markdown to HTML コンバーターでHTMLにレンダリングして、プロジェクトホームページでの表示を確認できます。
自動生成Shields.ioバッジ
バッジを含むを切り替えると、READMEの上部にshields.ioバッジの行が追加されます。npmバージョン、ライセンス、GitHub Actionsビルドステータス。バッジはプロジェクト名とGitHubユーザー名から生成されるため、プロジェクトが公開されると自動的に更新されます。コピー後に手動で追加のバッジを追加できます(ダウンロード、カバレッジ、依存関係、Discordなど)。
各READMEセクションへのリンク付き目次には、生成された出力に対して無料 Markdown TOC ジェネレーターをご利用ください。
6つのオープンソースライセンスピッカー
MIT、Apache 2.0、GPL-3.0、BSD 3-Clause、ISC、Unlicenseの6つの一般的なオープンソースライセンスから選択できます。READMEのライセンスセクションは即座に更新され、バッジが有効な場合はライセンスバッジも一致するように更新されます。他のライセンスやカスタム配置の場合は、コピー後にライセンスセクションを編集してください。
READMEにテーブル(機能比較、設定オプション、環境変数)を含める必要がある場合は、無料 Markdown テーブルジェネレーターで視覚的に構築できます。
オプションのContributingとTestsセクション
Contributingセクションのオンオフを切り替えて、プルリクエストとイシュー報告を歓迎するメッセージを含めることができます。Testsセクションを切り替えて、テストスイートの実行手順を含めます(デフォルトはnpm test、コピー後に編集可能)。Minimalテンプレートではデフォルトでオフ、その他ではデフォルトでオンです。プロジェクトの成長に合わせて個別に追加してください。
生成後に無料 Markdown フォーマッターで不整合を整理できます。
README ジェネレーター の使い方
ステップ 1 — テンプレートを選択する
プロジェクトの種類に応じてMinimal、Standard、Library、Web Appを選択します。
ステップ 2 — フォームに入力する
プロジェクト名、タグライン、説明、作者、インストールコマンド、使用コード、ライセンス。
ステップ 3 — コピーして貼り付ける
Copy READMEまたはDownload README.mdをクリックして、プロジェクトルートに配置します。
このツールの対象ユーザー
Open source maintainers
Shipping a polished README for every library release — no more 'figure out how to use this' friction.
Indie developers
Ship side projects with professional READMEs that make them look like real products.
Students building portfolios
Every project on your GitHub profile needs a README. This takes 2 minutes.
Hackathon teams
Ship your hackathon project with a real README even when you're running on 3 hours of sleep.
Technical writers
Starting from a solid template and customizing instead of staring at a blank file.
よくある質問
この無料READMEジェネレーターは本当に無料ですか?
はい。freemarkdowntools.comのすべてのツールは永久無料です。
バッジは含まれますか?
はい。npmバージョン、ライセンス、ビルドステータスのshields.ioバッジがデフォルトで含まれています。不要な場合はオフにしてください。
どのテンプレートがありますか?
Minimal(タイトル+ライセンス)、Standard(機能+使用法追加)、Library(APIセクション追加)、Web App(リポジトリクローン付きGetting Started追加)。
生成されたMarkdownは編集できますか?
はい。出力は通常のMarkdownです。コピーして任意のエディターでさらにカスタマイズできます。
データは保存されますか?
いいえ。ツールはブラウザ内で100%動作します。
関連する無料 Markdown ツール