Генератор README для GitHub
Создайте профессиональный README.md для проекта на GitHub: бейджи, описание, возможности, стек, установка, использование, переменные окружения, планы, участие, лицензия и автор.
Загрузка: Генератор README для GitHub…
Ваши файлы не покидают устройство
Как пользоваться: Генератор README для GitHub
- 1
Откройте «Генератор README для GitHub» на этой странице. Инструмент загружается прямо в браузере.
- 2
Добавьте файл, текст или значения и настройте параметры.
- 3
Скопируйте или скачайте результат. Ничего не загружается и не хранится.
Об инструменте
README это главная страница любого репозитория: его первым читают посетители, рекрутеры и контрибьюторы. Этот генератор README для GitHub собирает полный и хорошо структурированный README.md по короткой форме. Заполните данные проекта, включите или отключите разделы, выберите стек технологий и скопируйте Markdown или скачайте файл. Черновик сохраняется в браузере, пока вы работаете.
Как создать README
- Введите название проекта, слоган и описание.
- Добавьте репозиторий GitHub (user/repo), чтобы создать бейджи, и ссылку на демо, если она есть.
- Выберите нужные разделы и технологии вашего стека.
- Выберите лицензию: MIT, Apache 2.0, GPL 3.0, BSD 3-Clause, MPL 2.0 или Unlicense, и укажите автора.
- Проверьте предпросмотр, затем скопируйте Markdown или скачайте README.md.
Какие разделы можно добавить
- Бейджи shields.io: звёзды, лицензия и другие.
- О проекте и возможности: что делает проект и зачем.
- Стек технологий: используемые языки и фреймворки.
- Установка и использование с блоками кода.
- Переменные окружения, нужные для запуска.
- Планы развития, правила участия, лицензия и автор.
Каким должен быть хороший README
- Объясните суть одним предложением в самом начале.
- Покажите проект: скриншот или GIF вверху скажет больше абзацев текста.
- Сделайте установку копируемой: точные команды по порядку, которые работают на чистой машине.
- Обновляйте его, когда меняются команды или параметры.
Доработайте результат в редакторе Markdown, добавьте таблицы с помощью генератора таблиц Markdown и подсмотрите синтаксис в шпаргалке по Markdown.
Частые вопросы
Что должно быть в README?
Что делает проект, как его установить и использовать, стек технологий, как участвовать в разработке и лицензия. Бейджи и скриншот помогают быстро понять суть.
Куда положить файл README?
В корень репозитория, с именем README.md. GitHub автоматически показывает его на странице репозитория.
Можно ли добавить бейджи?
Да. Укажите репозиторий GitHub в виде user/repo, и генератор добавит для него бейджи shields.io.
Какие лицензии можно выбрать?
MIT, Apache 2.0, GPL 3.0, BSD 3-Clause, MPL 2.0 и Unlicense. Добавьте в репозиторий и полный файл LICENSE.
Сохраняется ли мой черновик?
Да, в локальном хранилище браузера, поэтому он будет на месте, когда вы вернётесь на том же устройстве.
Можно ли сделать README для профиля?
Да. Создайте репозиторий с названием, точно совпадающим с вашим именем пользователя, и расскажите о себе в README; GitHub покажет его в профиле.