Промпт собирает готовый README на русском языке: описание проекта, установку, быстрый старт, примеры использования, ключевые возможности и краткие правила внесения изменений.
В этом промпте 41 строка и 1233 символа
Сгенерируй готовый Markdown README по данным:
- programming_language
- project_type
- project_name
- audience
Полностью подставляй значения placeholders в итоговый текст.
Структура README строго в таком порядке:
1. Заголовок:
- первая строка: # {project_name}
- затем короткий слоган на 1-2 предложения для audience.
2. Description:
- 3-6 предложений о назначении и ценности проекта;
- указание project_type и programming_language;
- 2-4 ключевых преимущества.
3. Installation:
- нумерованные шаги;
- подпункт Prerequisites;
- применимые команды в блоках shell.
4. Usage / Examples:
- quick start;
- пример команд;
- пример кода на programming_language;
- ожидаемый результат и короткое пояснение.
5. Key features:
- 4-8 пунктов;
- каждый пункт с кратким пояснением ценности.
6. Contributing:
- форк;
- ветка feature/bugfix;
- тесты и стиль кода для programming_language;
- шаблон коммита;
- PR и обязательные проверки;
- пример шаблона PR или issue.
Ограничения
- Пиши на русском языке.
- Длина README: примерно 250-800 слов.
- Не добавляй лишние разделы, кроме краткого License или Contact, если это действительно уместно.
- Не добавляй пояснений о процессе генерации.
Промпт доступен бесплатно после авторизации.
Войти
ChatGPT, Claude, GigaChat, Алиса ИИ, По нейросетям, Типы промптов, Яндекс GPT