Promptigo
Coding

Write a README

A no-fluff README with only the sections your project actually needs filled in.

Beginner1 min read
#documentation#readme#open-source

Customize

Fill these in and the prompt below updates as you type. Anything you leave blank stays as a placeholder.

Your prompt

4 placeholders left
Write a README.md for the following project.

Project name: {{project_name}}
What it does: {{description}}
Tech stack: {{tech_stack}}
Target audience: {{audience}}

Include sections for: overview, prerequisites, installation, usage with examples, environment variables, running tests, and contributing.

Use a practical, no-fluff tone. Don't add sections that would be empty.

Similar prompts

Coding
Document a Function or Module

Complete JSDoc or docstrings with precise types, throws, constraints, and a usage example.

#documentation#jsdoc#types
Coding
Document What You Built

Update docs strictly from the diff, with no invented features.

#agent#documentation#workflow
Coding
Function From Requirements

A typed, documented function built to spec — with three unit tests covering the edge and error cases.

#code-generation#testing#documentation
Coding
Pull Request Description

Turn a diff into a scannable PR write-up with risks, rollback, and a reviewer checklist.

#git#collaboration#documentation