readme.txt -> README.md

hufrea / byedpi

Bypass DPI

MIT License

1.24k stars 94 forks source link

readme.txt -> README.md #77

Closed vladiscripts closed 2 weeks ago

vladiscripts commented 1 month ago

Описание приложения в readme.txt сложновато читать, поскольку нет оформления разметкой MD markdown. Хотя в тексте коды этой разметки присутствуют - ### в заголовках разделов. Чтобы разметка работала надо переименовать readme.txt в README.md.

hufrea commented 4 weeks ago

Дело в том, что раздел "Описание аргументов" занимал большую часть текста, а он должен быть написан моноширинным шрифтом. В итоге в MD была лишь пара предложений, а остальная часть являлась "кодом", что смотрелось плохо.

vladiscripts commented 4 weeks ago

Посмотрел как делают на GitHub. Блоки описания аргументов CLI обычно целиком заключают в блок с моноширным шрифтом. Примеры 1, 2, поиск по всем github-вики, gist.

PR https://github.com/hufrea/byedpi/pull/84 (preview). Markdown требует пустой строки для разделения абзацев, поэтому кое-где их можно поправить.