a11y.skipToMainContent
1

Bộ tạo thư mụcName

Tạo ra các tập tin d.md chuyên nghiệp cho dự án của anh. Bao gồm các phù hiệu, hướng dẫn cài đặt, ví dụ sử dụng và đóng góp hướng dẫn.

README Generator
README.md
More options
Was this tool helpful?
Send output to:
Advertisement

How to use README Generator

  1. Chọn kiểu dự án.
  2. Hãy điền vào chi tiết về dự án (tên, mô tả, chồng công nghệ).
  3. Cấu hình các phần và huy hiệu.
  4. Sao chép các tạo vật ReadME.md.

Tên là gì?

Một máy phát điệnEditME tạo toàn diện tập tin ReadME.md cho các dự án phần mềm. Nó bao gồm các phần cho mô tả dự án, cài đặt, sử dụng, tài liệu hướng dẫn của API, đóng góp các hướng dẫn, và thông tin giấy phép. Công cụ này cung cấp các mẫu cho các loại dự án khác nhau (library, CLI công cụ, ứng dụng web, API) và tạo ra các phù hiệu cho việc xây dựng trạng thái, bảo hiểm, phiên bản và giấy phép.

Advertisement

FAQ

Bao gồm những phần nào?
Tiêu đề, phù hiệu, mô tả, cài đặt, sử dụng, ARI, đóng góp, bằng lái, và phần FAQ.
Tôi có thể tùy chỉnh mẫu không?
Đúng vậy, cho phép hoặc tắt các phần và tùy chỉnh nội dung cho mỗi phần.

Related tools

Author

MW
Marcus Webb"The DevTool Craftsman"

Full-Stack Developer & Tools Architect

Marcus has been writing code since the dial-up era. He has contributed to open-source developer tools, built CI/CD pipelines for startups, and debugged production incidents at 3 AM more times than he would like to admit. His philosophy is that the best developer tool is the one that gets out of your way, and he writes about practical tooling that helps teams ship faster with fewer headaches.

Advertisement