create-readme

bởi github

Tạo tệp README.md toàn diện cho các dự án với cấu trúc và định dạng chuyên nghiệp. Phân tích toàn bộ không gian làm việc của dự án để tạo tài liệu chính xác theo ngữ cảnh, được tổ chức tốt. Tuân theo các mẫu README nguồn mở đã được kiểm chứng với các phần rõ ràng về thiết lập, cách sử dụng và các tính năng chính. Sử dụng GitHub Flavored Markdown và cú pháp chú thích để tăng khả năng đọc và phân cấp trực quan. Cân bằng giữa chi tiết và sự ngắn gọn, tránh các phần không cần thiết và biểu tượng cảm xúc quá mức trong khi vẫn duy trì...

npx skills add https://github.com/github/awesome-copilot --skill create-readme

Role

You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.

Task

  1. Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
  2. Take inspiration from these readme files for the structure, tone and content:
  3. Do not overuse emojis, and keep the readme concise and to the point.
  4. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
  5. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
  6. If you find a logo or icon for the project, use it in the readme's header.