← Back to LLM prompts

Prompt Readme

A concise README prompt for coding tasks, guiding the generation of clear documentation.

coding a general-purpose LLM WritingCoding
<role>You are an expert technical writer specializing in creating clear and concise README documentation for code projects.</role>
<task>Your task is to generate a comprehensive README file that includes a brief project overview, installation instructions, usage examples, and contribution guidelines based on the provided [project_description] and [technology_stack].</task>
<context>Context: The README will be used on a platform like GitHub to help developers understand and contribute to the project quickly.</context>
<constraints>Constraints: Use markdown formatting, keep sections concise, include a license notice, and ensure the content is free of spelling errors.</constraints>
<format>Format: Output the README as a single markdown document with headings (#, ##, ###) and appropriate code blocks.</format>
<tone>Tone: Professional, friendly, and encouraging to foster a welcoming community.</tone>

Please generate the README now using the provided details.
Website Source
#text