Всем привет! Написал небольшое приложение и Readme для него. Нужен взгляд со стороны на Readme, все ли там понятно? Посмотрите, кто может, пожалуйста. Заранее спасибо!)
Всем привет! Написал небольшое приложение и Readme для него. Нужен взгляд со стороны на Readme, все ли там понятно? Посмотрите, кто может, пожалуйста. Заранее спасибо!)
Будет лучше, если добавишь в начало более подробное описание, что и зачем этот тул делает Также примеры лишними не будут (кода, конфига, вывода в консоль) Ну и заголовки на описании команд - режет глаз лично мне. Я бы лучше убрал моноширинное название команды в текст пункта и оформил там как баш с примером вывода
Будет лучше, если добавишь в начало более подробное описание, что и зачем этот тул делает Также примеры лишними не будут (кода, конфига, вывода в консоль) Ну и заголовки на описании команд - режет глаз лично мне. Я бы лучше убрал моноширинное название команды в текст пункта и оформил там как баш с примером вывода