Файл README.md — это руководство, которое дает пользователям подробное описание проекта, а так же является первым, на что обращает внимание читатель заходя в репозиторий, поэтому он должен быть кратким, но информативным. Я предлагаю использовать мой шаблон как базу, которую со временем можно прокачивать...

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