Trinh tao README

Tao README GitHub hoan hao trong vai phut.

Template:
Phần tùy chọn

Tóm tắt — Trinh tao README miễn phí làm gì

Công cụ miễn phí này là gì

Trình tạo README miễn phí xây dựng README.md hoàn hảo cho GitHub từ form ngắn. Chọn template (Minimal, Standard, Library hoặc Web App), điền tên dự án, mô tả, tác giả, lệnh cài đặt và code sử dụng — nhận README hoàn chỉnh trong vài giây. Badge, giấy phép, phần đóng góp và test chỉ cách một công tắc.

Quyền riêng tư: Công cụ này chạy hoàn toàn trên trình duyệt của bạn. Văn bản của bạn không bao giờ được tải lên, ghi log, hay lưu cache. Đóng tab và dữ liệu sẽ biến mất. Kiểm tra tại DevTools → Network: không có request nào được gửi đi.

Tại sao miễn phí (và chúng tôi duy trì miễn phí như thế nào)

README tốt là sự khác biệt giữa dự án mã nguồn mở người ta dùng và dự án bị quên. Chúng tôi muốn mọi công cụ miễn phí, mọi thư viện indie, mọi dự án cá nhân đều có README tốt. Vì vậy miễn phí mãi mãi.

Bảng hướng dẫn sử dụng

Thông tin nhanh

Đầu vàoĐầu raKích thước thông thườngTốc độCần đăng nhập
Form fieldsREADME.md (GitHub-ready)Any projectReal-timeNo

Tính năng của Trinh tao README

Dưới đây là chi tiết những gì công cụ miễn phí này làm — mọi tính năng đều được xây dựng để giải quyết vấn đề thực tế, chạy hoàn toàn trên trình duyệt, và miễn phí mãi mãi.

4 template dự án

Chọn template phù hợp: Minimal (tên + mô tả + giấy phép) Standard (thêm tính năng và sử dụng) Library (thêm phần API với function signatures) hoặc Web App (thêm Getting Started).

Khi có nội dung README, render thành HTML bằng Trình chuyển đổi Markdown sang HTML để xem trước.

Badge Shields.io tự động

Bật Bao gồm badge để thêm hàng badge shields.io phía trên README: phiên bản npm, giấy phép, và trạng thái build GitHub Actions.

Cho mục lục liên kết đến từng phần, dùng Trình tạo mục lục Markdown.

6 tùy chọn giấy phép mã nguồn mở

Chọn từ MIT, Apache 2.0, GPL-3.0, BSD 3-Clause, ISC hoặc Unlicense: 6 giấy phép mã nguồn mở phổ biến nhất. Phần giấy phép README cập nhật ngay, và nếu badge bật, badge giấy phép cập nhật khớp.

Phần đóng góp và test tùy chọn

Bật phần Contributing để chào đón pull request và báo cáo vấn đề. Bật phần Tests để hướng dẫn chạy test suite. Cả hai tắt mặc định trong Minimal; bật mặc định trong các template khác.

Sau khi tạo, làm sạch với Markdown Formatter.

Cách sử dụng Trinh tao README miễn phí

Bước 1 — Chọn template

Chọn Minimal, Standard, Library hoặc Web App theo loại dự án.

Bước 2 — Điền form

Tên dự án, tagline, mô tả, tác giả, lệnh cài đặt, code sử dụng, giấy phép.

Bước 3 — Bật phần tùy chọn

Thêm hoặc bỏ badge, Contributing hoặc phần Tests.

Ai có thể sử dụng công cụ này

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.

Câu hỏi thường gặp

Trình tạo README có thực sự miễn phí không?

Có. Mọi công cụ trên freemarkdowntools.com miễn phí mãi mãi.

Có badge không?

Có. Badge shields.io cho phiên bản npm, giấy phép và trạng thái build mặc định có. Tắt nếu không muốn.

Có template nào?

Minimal (tên + giấy phép), Standard (thêm tính năng + sử dụng), Library (thêm API), Web App (thêm Getting Started).

Có thể sửa Markdown đã tạo không?

Có. Đầu ra là Markdown thông thường — sao chép, dán và tùy chỉnh trong trình soạn thảo bất kỳ.

Dữ liệu có bị lưu không?

Không. Công cụ chạy 100% trong trình duyệt.

Công cụ Markdown miễn phí liên quan