Генератор README

Заполните основные сведения о проекте: инструмент создаст структурированный файл README.md (заголовок, описание, установка, использование, лицензия), готовый к копированию или скачиванию.

Пример:

Как это работает

Укажите название проекта (единственное обязательное поле), описание, команду установки, пример использования и лицензию. Инструмент соберёт эти сведения в структурированный документ Markdown с заголовком, оглавлением, разделами «Установка» и «Использование» с блоками кода и разделом «Лицензия». Структура близка к той, что рекомендуется в большинстве руководств по участию в проектах на GitHub.

Можно ли изменить README после генерации?

Да, сгенерированный текст — редактируемая отправная точка, как любой Markdown: после копирования или скачивания файла добавьте разделы (Участие, Тесты, Скриншоты) прямо в привычном редакторе.

Работает ли значок лицензии для любой лицензии?

Значок создаётся через сервис shields.io с названием лицензии в том виде, как вы его ввели; он корректно отображается для распространённых лицензий (MIT, Apache-2.0, GPL-3.0…). Для нестандартной лицензии значок остаётся рабочим, но выглядит менее стандартно.

Все введённые сведения остаются в вашем браузере: для создания этого README ничего не отправляется на сервер.