Developer ابزار به‌روزرسانی شد 2 ماه پیش

GitHub README Generator

Generate a professional GitHub README.md with badges, sections, installation instructions, usage examples, and license information.

همیشه رایگان استفاده آسان نتایج فوری خصوصی و امن

استفاده GitHub README Generator

GitHub README Generator

Generate a clean README.md with badges, features, install steps, usage, contributing, and license sections.

Generate README Clear

Project Details

Basic repository information
Owner and repo are used for badges.
Project: unnamed
Repo not set
Not generated yet
README status
0 sections
Generated sections

README.md

Generated Markdown output
Copy README Download
Output: 0 chars
0 lines

README Content

Features, installation, usage, and badges
One feature per line. Leading dashes are optional.
Build and stars badges require GitHub owner and repo name.
0 features
1 badge selected
README tip
Add owner and repo to enable badge URLs. Generate first, then copy or download the README.md file.
لینک ابزار
به کلیپ‌بورد کپی شد.
اشتراک‌گذاری
فیسبوک توییتر واتس‌اپ پینترست لینکدین تلگرام ردیت تامبلر وی‌کی خط
به بهبود این ابزار کمک کنید
گزارش درخواست نظرات

محتوا را بخوانید

بیاموزید که این ابزار چگونه کار می‌کند و چه زمانی باید از آن استفاده کنید.

The GitHub README Generator helps you create polished, well-structured README.md files for your GitHub repositories. A great README makes your project easier to understand, install, and contribute to.

Why Use This Tool?

A well-written README is essential for any GitHub project. This generator builds a complete template with Features, Install, Usage, Contributing, and License sections, plus optional shields.io badges — all from a simple form.

How It Works

  • Enter the project name, description, license, and GitHub owner/repo (used to build badge URLs).
  • List your features (one per line) and add Install and Usage text, optionally marked as code blocks with a custom language.
  • Toggle the badges you want: License, Build status, and Stars.
  • Click Generate to preview the Markdown output.
  • Copy the README to your clipboard or download it as a .md file.

Key Features

  • Complete template with Features, Install, Usage, Contributing, and License sections
  • shields.io badges for License, Build, and Stars
  • Optional code-block formatting for Install and Usage with custom language
  • Live character, line, and section counters
  • Copy to clipboard and download as .md
  • Free online tool, no signup

نظرات (0)

برای بحث کاربران، موارد حاشیه‌ای و نکات پیگیری.
یک نظر بگذارید
نظر شما پس از ارسال به‌صورت عمومی نمایش داده خواهد شد.
هنوز نظری ثبت نشده است. اولین نفری باشید که نظر می‌دهد!
به ما اطلاع دهید!
گزارش مشکل این ابزار

مسئله‌ای را که با آن مواجه شدید شرح دهید تا بتوانیم آن را بررسی کرده و ابزار را بهبود بخشیم.

چه چیزی بیشتر کمک می‌کند
ورودی، نتیجهٔ مورد انتظار، نتیجهٔ واقعی، مرورگر/دستگاه و در صورت کمک‌کننده بودن، یک اسکرین‌شات را درج کنید.
دکمهٔ اسکرین‌شات صفحه را در مرورگر ثبت می‌کند و تصویر تولیدشده را به این فرم پیوست می‌کند.
اسکرین‌شات تمام‌صفحه
در مرورگر شما با newisty ضبط شده است.
هنوز هیچ اسکرین‌شاتی گرفته نشده است.
ابزار گزارش