readme.md

readme.md - документация Unit, самый важный элемент любого репозитория, от полноты информации в этом файле будет зависеть лёгкость эксплуатации Unit другими людьми.

TIP

Для решения задачи поддержания единообразия в документациях Unit, у каждого инстанса Pepeunit есть генератор readme.md на основе pepeunit.toml. Генератор позволяет преобразовать машиночитаемый pepeunit.toml в человекочитаемый readme.md.

Генерация readme.md

INFO

Чтобы найти генератор, кликните по своему никнейму в правом верхнем углу, затем нажмите на кнопку Generate README.md. Вам будет предложено выбрать pepeunit.toml файл. После утверждения файла, скачивание readme.md произойдёт автоматически.