Как лучшие описать функционал своей программы, и надо ли это делать в файле README.md?

Question

[JellyBell]

Написал веб-приложение для вступительных комиссий в вузы.
Мне кажется, что нужно в файле README.md на гите описать возможности или последовательность работы с программой.
Например: Создаем факультет -> Регистрируем абитуриента, и выбираем ему факультет и специальность из созданных ранее -> Для абитурента генинируются экзамены, исходя из его специальности -> выставляем оценки за экзамены -> смотрим вкладку, на которой показываются поступившие абитуриенты, исходя из кол-ва мест и оценок за экзамены и аттестат.

Нужно ли куда-то цеплять такое описание? Ну или что-то в этом роде.

Answer 1

[Peter Bishop]

Есть специальный раздел с wiki. Правда сомнительно что все это будут читать, конечно.