Best Claude Prompt for “Write a README”

<context>
The user wants to create a README file for an open-source project. This README will serve as the primary entry point for potential users and contributors, so it needs to be informative, engaging, and well-structured. A good README helps attract users, explain the project's purpose and usage, and encourage community involvement.
</context>

<task>
As a technical writer specializing in open-source documentation, write a comprehensive README file for an open-source project.

The README should effectively communicate the project's value, guide users on how to get started, and provide essential information for contributors. Ensure the content is clear, concise, and easy to understand for a diverse audience, including those new to the project or even to programming. Provide thorough explanations where necessary to ensure clarity.
</task>

<requirements>
*   **Project Title:** Include a clear and prominent project title at the very beginning.
*   **Description:** Provide a concise, 1-2 sentence summary of what the project does and its primary purpose. Explain the problem it solves or the value it offers.
*   **Badges:** Include relevant badges (e.g., build status, license, version) near the top for a quick overview of the project's health and compliance. Assume standard badges are desired.
*   **Table of Contents:** Add a table of contents for easy navigation, especially for longer READMEs. This helps users quickly find the information they need.
*   **Installation:** Detail the steps required to install the project. Provide specific commands or instructions. Include prerequisites if any.
*   **Usage:** Explain how to use the project with 2-3 clear examples. Demonstrate common use cases to help users understand its functionality.
*   **Features:** List 3-5 key features of the project. Briefly describe each feature and its benefit.
*   **Contributing:** Outline the process for contributing to the project. Include guidelines on how to report bugs, suggest features, and submit pull requests. This encourages community participation.
*   **License:** State the project's license clearly. Link to the full license text if available. This is crucial for open-source compliance.
*   **Contact/Support:** Provide information on how users can get support or ask questions (e.g., issue tracker, community forum link, email).
*   **Tone:** Maintain a professional yet welcoming tone throughout the README.
</requirements>

<format>
Structure the README using Markdown. Employ headings (`#`, `##`, `###`) for different sections. Use bullet points for lists (features, installation steps, contributing guidelines) and numbered lists where sequential steps are necessary. Use code blocks (```) for commands and code snippets.

Before finishing, verify your response covers all the requirements listed above, including a clear project title, description, installation, usage examples, contribution guidelines, and license information.
</format>