автор: lbaela, 8 волна, https://t.me/antislack

Что должно быть в ReadMe?

1. Название проекта
2. Описание в 1-2 предложениях (Что из себя представляет программа, которую вы написали?)
3. Учебная цель проекта (Какие возможности языка или области/темы программирования вы изучили, работая над проектом?)
4. По желанию, можно указать, если это школьный проект

В комментариях можно скачать простейший Ридми с базовой разметкой, который можно взять за основу.

Из полезных ресурсов, могу порекомендовать онлайн редактор Ридми с instant-превью: dillinger.io

Как закончите с Readme, отредактируйте Repository details: На странице репозитория справа от списка файлов есть свой About. Там нужно добавить описание: description, website (если у проекта есть своя страница) и topics.

Важный вопрос на обсуждение: как считаете, на каком языке должен быть написан ReadMe?

Дополняем свои ReadMe:

1. Добавляем блок “to compile/to run”. Подумайте, что должен знать человек, чтобы запустить вашу программу? Есть ли какие-то флаги, нужны ли аргументы? Где брать файлы, принимаемые программой? Здесь пригодится маркап code-block-а:

   
   # to build
   make
   

2. Укажите языки и стек технологий, использованные при написании проекта.

3. Если над проектом вы работали в команде, укажите это и добавьте ссылки на профили контрибьюторов.

Наверняка вы замечали, что в ReadMe часто добавляют бейджи – last commit, licensing, stars, language used, etc. Если есть желание добавить визуальных акцентов, вот полезные ссылки на сегодня – shields.io (https://shields.io/), badgen.net (https://badgen.net/).

Добавляем картинки: