Best Gemini Prompt for “Write a README

Gemini uses a sandwich structure: role and context at the top, task in the middle, and all constraints at the end. Gemini tends to drop constraints that appear early in the prompt, so boundary words like 'only', 'must', and 'strictly' placed at the end are essential. This free template is optimized specifically for Gemini, achieving approximately 37% token reduction compared to unoptimized prompts while producing higher quality output.

Optimize Any Prompt Instantly

Stop manually formatting prompts for each AI model. PromptOptimizr auto-restructures your prompts for ChatGPT, Claude, Gemini, Cursor, and Claude Code — with 3 optimization styles.

What Most People Type

Write a README for my open source project

Optimized Gemini Prompt

<role>
As an expert technical writer specializing in open-source documentation, your task is to generate a comprehensive README file.
</role>

<context>
The user has an open-source project and needs a README file to introduce it to potential users and contributors. The README should be informative, engaging, and guide users on how to get started and interact with the project.
</context>

<task>
Write a README for an open-source project.
</task>

<constraints>
- The README must include sections for: Project Title, Description, Features, Installation, Usage, Contributing, and License.
- For the Features section, list 3-5 key features.
- For the Installation section, provide clear, step-by-step instructions.
- For the Usage section, include 1-2 practical examples.
- For the Contributing section, outline 2-3 guidelines for contributors.
- The tone should be professional yet accessible.
- Strictly adhere to the requested sections and bounded quantities.
</constraints>

<output_format>
The output should be a single, well-formatted README file suitable for direct use in a code repository. Use Markdown for formatting.
</output_format>

<final_instruction>
The README must be comprehensive and clearly explain the project. Explain each point thoroughly. Ensure the sections are logically ordered and easy to navigate. Strictly avoid adding any information or sections not explicitly requested. Only include the sections specified in the constraints.

Before responding, review your output against the original request.
</final_instruction>

Why This Gemini Prompt for “Write a README” Works Better

When you type “Write a README for my open source project” into Gemini, it lacks structure — Gemini has to guess what format you want, how detailed to go, and what to prioritize. The optimized version removes that guesswork.

It uses a sandwich structure with role and context at the top, the task in the middle, and all hard constraints at the end — matching how Gemini processes and prioritizes instructions.

This Prompt Optimized for Other AI Models

Each AI model processes instructions differently. See how this same prompt is optimized for:

Frequently Asked Questions

What makes a good Gemini prompt for write a readme?

Gemini uses a sandwich structure: role and context at the top, task in the middle, and all constraints at the end. Gemini tends to drop constraints that appear early in the prompt, so boundary words like 'only', 'must', and 'strictly' placed at the end are essential.

Can I use this prompt template for free?

Yes — copy the optimized prompt below and paste it directly into Gemini. For unlimited prompt optimization across all 5 AI models, try PromptOptimizr free with 10 prompts per month. You can also use the Chrome extension to optimize prompts directly inside Gemini.

Why is this prompt different from a generic one?

Each AI model processes instructions differently. Gemini has specific formatting preferences — this prompt is structured to work with those preferences, not against them. The result is better output quality with approximately 37% fewer tokens.

More Gemini Prompt Templates

Optimize Prompts Without Leaving Gemini

The PromptOptimizr Chrome Extension injects directly into Gemini's interface. No tab switching — click the optimize button right inside the chat, pick your style, and get a model-specific prompt instantly. Works inside ChatGPT, Claude, and Gemini.

Get the Free Chrome Extension →