README

Добавить описание проекта можно в файл readme.md. Создать файл можно 2-мя способами:

1) Создать в проекте в PyCharm файл с названием readme.md и сделать commit в свой репозиторий

2) Зайти в репозиторий своего проекта на github.com и создать это файл прям на сайте:

.md - это расширение для файлов, написанных на Markdown - облегченном языке разметки (Markdown). Описание возможностей разметки можно посмотреть тут.

Содержимое файла readme.md будет отображаться на странице вашего репозитория.

readme.md в PyCharm

readme.md на сайте

Google Sites

Report abuse