Просто сваять проект недостаточно, надо все это дело правильно оформить Оформление Обычный стандарт – шрифт Times New Roman, 14, интервал полуторный. Абзацы делаются красной строкой (хотя, думаю, можно и пробелами)...

Источник: Nuances of Programming Readme  —  это детальное описание проекта. В нем содержится информация о том, что представляет собой проект, кто его авторы, как он устанавливается или настраивается, как используется и прочие данные. Readme  —  визитная карточка проекта. Всякий раз, когда кто-то заходит в репозиторий, он первым делом просматривает readme-файлы, чтобы получить представление о проектах. Детальный readme создает хорошее первое впечатление о проекте. Хотите узнать, как создать впечатляющий...