Skip to main content
affpapa.org
RU EN
rule

readme-best-practices-cursorrules-prompt-file — Cursor rule

This rule guides an agent writing project READMEs, from the opening pitch to a runnable Quick Start. Use it when you want documentation readers can scan and try.

Install into Cursor · Manually: put the files in place All methods and platforms ↓ 
.cursor/rules/readme-best-practices-cursorrules-prompt-file.mdc
Open on GitHub

What readme-best-practices-cursorrules-prompt-file does

The rule asks for a README that introduces a project’s value instead of reading like an API reference. It calls for a concise opening, followed by a working code sample near the top, and recommends a two-column table for feature descriptions.

The Quick Start should use commands readers can copy directly, without a $ before shell commands. The rule also calls for varied sentence structure, avoids marketing clichés, and tells the agent to confirm that linked images or other assets exist on disk. For the author section, it recommends a visual card or badge. In Cursor, place the rule at .cursor/rules/readme-best-practices-cursorrules-prompt-file.mdc. Its frontmatter sets alwaysApply to false, with globs set to **/*.

What it helps with

  • write a clear opening for a project README
  • put a runnable code sample near the start
  • draft a Quick Start with copy-ready commands
  • present features in a two-column table
  • check linked image files and style the author section

Example prompts for the agent

  • Rewrite this project README with a concise opening and a working code sample near the top.
  • Draft a Quick Start for this README using commands readers can copy and run.
  • Review the README, turn the feature list into a two-column table, and check that linked image files exist.

How to install readme-best-practices-cursorrules-prompt-file

Manually: put the files in place

.cursor/rules/readme-best-practices-cursorrules-prompt-file.mdc

Frontmatter: description, globs, alwaysApply

Step by step, with commands for each platform: Cursor rules: .mdc files, four modes and what replaced .cursorrules

Questions about readme-best-practices-cursorrules-prompt-file

How do I install readme-best-practices-cursorrules-prompt-file in Cursor?

Create .cursor/rules/readme-best-practices-cursorrules-prompt-file.mdc and add the rule contents to that file.

What does readme-best-practices-cursorrules-prompt-file do?

It guides README structure, including the opening, an early code sample, a copy-ready Quick Start, and a feature table. It also asks the agent to check linked assets and use a visual author card or badge.

Does the rule apply to every file automatically?

No. Its frontmatter sets alwaysApply to false, while globs is set to **/*.

Source text

readme-best-practices-cursorrules-prompt-file.mdc · CC0-1.0 
---
description: "Cursor rules for README documentation with best practices integration."
globs: **/*
alwaysApply: false
---
Write READMEs like landing pages, not API docs. The reader decides in 3-5 seconds.

Start with a bold one-liner saying what it does and why someone should care. Not "A tool that..." - a punchline.
Put a working code example in the first 5 lines. Show the value prop immediately.
Use feature tables (two columns) instead of **Feature:** bullet lists. Tables scan faster.
Quick Start must be copy-paste ready. No $ prefix on bash commands. Zero to running in 30 seconds.
Vary sentence lengths and structure. Mix one-liners with short paragraphs and tables. Not walls of same-length bullets.
Never use "seamless", "robust", "comprehensive", "cutting-edge", or other AI marketing words.
Never open with "In today's..." or close with "Happy coding!"
Check that referenced assets (demo.gif, screenshots) actually exist on disk before adding image links.
Author section should include a visual card or badge, not just plain text "Made by username".

© PatrickJS · CC0-1.0 · PatrickJS/awesome-cursorrules

Similar IDE rules

All IDE rules for Writing and docs →
use-cliche-data-in-docs official github This rule keeps real values from local files and prompts out of docs, replacing them with plausible fictional examples. Use it when writing or revising documentation. ★ 40,451repo stars update-docs-on-code-change official github A GitHub Copilot rule that flags when README.md and other docs need updating after code changes. Useful when your docs drift behind the code. ★ 40,451repo stars spec-driven-workflow-v1 official github This rule structures work from requirements analysis through design, implementation, and validation. Use it when you want decisions and progress recorded in project files. ★ 40,451repo stars power-apps-canvas-yaml official github This rule guides GitHub Copilot when editing Canvas Apps YAML and Power Fx formulas. Use it to shape screens, controls, components, and data connections. ★ 40,451repo stars pcf-manifest-schema official github A rule that feeds Copilot the structure of ControlManifest.Input.xml: which elements and attributes exist and what they do. Useful when editing a PCF component manifest. ★ 40,451repo stars markdown official github This rule guides GitHub Copilot when it writes or reviews .md files using CommonMark 0.31.2. Its file pattern targets Markdown documents. ★ 40,451repo stars

From the same set210

salesforce-apex-cursorrules-prompt-file A Cursor rule that points the agent at Salesforce Apex work: queueables instead of @future, GoF patterns, and almost no comments. ★ 41,024repo stars rust-general This rule guides safe, idiomatic Rust work. It fits projects where .rs, Cargo.toml, and Cargo.lock need consistent coding guidance. ★ 41,024repo stars rtl-right-to-left-i18n-cursorrules-prompt-file A Cursor rule that pushes the agent toward logical CSS and Tailwind utilities instead of left/right. Useful when the app has to run in Arabic, Hebrew, Persian or Urdu. ★ 41,024repo stars ros-ros2 Enforces conventions for ROS and ROS2 workspaces, covering composable nodes, package layout, and launch testing. ★ 41,024repo stars react This rule hands Cursor a set of React conventions: component structure, hooks, state, forms and accessibility. Useful when a project has plenty of .tsx and .jsx and you want one style. ★ 41,024repo stars react-zustand-cursorrules-prompt-file Cursor guidance for React and TypeScript projects using Zustand. It standardizes store design, stops unnecessary re-renders, and keeps server state separate from client stores. ★ 41,024repo stars react-typescript-symfony-cursorrules-prompt-file A Cursor rule that steers the assistant toward readable code across React, TypeScript, PHP, Symfony and Docker. ★ 41,024repo stars react-typescript-nextjs-nodejs-cursorrules-prompt- A Cursor rule that pins down React, TypeScript, Next.js 14 and Node.js conventions: functional components, RORO, minimal use client. ★ 41,024repo stars

Project sponsors

Companies that keep this analytics open
Gold sponsor
Nutra.Club

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor