Написание README для open source проекта

Claude Код ★ 4.6 (215)

Готовит профессиональный README с описанием, установкой, использованием и структурой проекта по стандартам сообщества.

Промпт

Напиши README.md для моего проекта.

ИНФО О ПРОЕКТЕ:
- Название: [НАЗВАНИЕ]
- Что делает (1 предложение): [ОПИСАНИЕ]
- Язык/стек: [ТЕХНОЛОГИИ]
- Тип: [библиотека/сайт/CLI/бот]
- Лицензия: [MIT/Apache/etc]
- Ссылка: [GITHUB_URL]

ДОПОЛНИТЕЛЬНО:
[ОПИШИ ОСОБЕННОСТИ: что выделяет проект, зачем создан]

Структура README:
1. Заголовок + краткое описание (1-2 строки)
2. Бейджи (build status, версия, лицензия)
3. Скриншот/демо (плейсхолдер)
4. Возможности (5-7 пунктов)
5. Установка (для каждой популярной ОС)
6. Быстрый старт (минимальный пример)
7. Использование (3-5 типичных сценариев с кодом)
8. Конфигурация (если применимо)
9. Вклад (как помочь проекту)
10. Лицензия
11. Контакты автора

Язык: на русском и на английском (две версии).

Пример результата

# MyAwesomeLib Лёгкая библиотека для парсинга PDF-файлов на Python. Работает в 10 раз быстрее аналогов...

Похожие промпты

Полезные статьи

Все гайды →