readme-best-practices-cursorrules-prompt-file — правило Cursor
Правило задаёт структуру README: короткий заход, рабочий пример в начале и готовый к копированию Quick Start. Пригодится, когда агент пишет документацию проекта.
.cursor/rules/readme-best-practices-cursorrules-prompt-file.mdcЧто делает readme-best-practices-cursorrules-prompt-file
Правило просит оформлять README как страницу, которая сразу объясняет ценность проекта, а не как справочник API. В начале нужен короткий тезис о назначении и пользе, затем — работающий пример кода в первых строках. Для списка возможностей предлагаются таблицы из двух колонок вместо перечня пунктов.
Quick Start должен содержать команды, которые можно скопировать и запустить; перед bash-командами не ставится $. Правило также задаёт разнообразный ритм текста, запрещает рекламные клише и требует проверить, что упомянутые изображения и другие файлы действительно есть на диске. Для блока об авторе предлагается карточка или бейдж. В Cursor файл размещают по пути .cursor/rules/readme-best-practices-cursorrules-prompt-file.mdc; alwaysApply выключен, хотя область globs задана как **/*.
Какие задачи решает
- написать начало README с ясным описанием проекта
- показать работу проекта в раннем примере кода
- собрать Quick Start из готовых к копированию команд
- заменить список возможностей двухколоночной таблицей
- проверить ссылки на изображения и оформить блок автора
Примеры запросов агенту
- Перепиши README проекта: начни с короткого объяснения его пользы и добавь рабочий пример кода в начало.
- Сделай Quick Start для README с командами, которые можно скопировать и запустить.
- Проверь README: сведи возможности в двухколоночную таблицу и проверь, что файлы изображений существуют.
Как установить readme-best-practices-cursorrules-prompt-file
Вручную: положить файлы
.cursor/rules/readme-best-practices-cursorrules-prompt-file.mdcВо frontmatter: description, globs, alwaysApply
Вручную: положить файлы
.claude/rules/readme-best-practices-cursorrules-prompt-file.mdПоле paths во frontmatter ограничивает файлы: globs из источника → paths
AGENTS.md
Codex читает AGENTS.md: вставьте текст правила туда
Вручную: положить файлы
.github/instructions/readme-best-practices-cursorrules-prompt-file.instructions.mdПоле applyTo задаёт, к каким файлам применять: globs из источника → applyTo
Вручную: положить файлы
.devin/rules/readme-best-practices-cursorrules-prompt-file.mdВручную: положить файлы
.clinerules/readme-best-practices-cursorrules-prompt-file.mdПо шагам, с командами для каждой платформы: Cursor rules: файлы .mdc, четыре режима и замена .cursorrules
Вопросы о readme-best-practices-cursorrules-prompt-file
Как установить readme-best-practices-cursorrules-prompt-file в Cursor?
Создай файл .cursor/rules/readme-best-practices-cursorrules-prompt-file.mdc и помести в него содержимое правила.
Что делает readme-best-practices-cursorrules-prompt-file?
Задаёт рекомендации для README: ясное начало, ранний пример кода, копируемый Quick Start и таблицу возможностей. Также просит проверять файлы изображений и оформлять сведения об авторе карточкой или бейджем.
Нужно ли правилу применяться всегда?
Нет: в frontmatter alwaysApply установлено в false. При этом область globs задана как **/*.
Исходный текст
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
