J
J
JellyBell2021-02-25 15:06:42
GitHub
JellyBell, 2021-02-25 15:06:42

What is the best way to describe the functionality of your program, and should it be done in the README.md file?

Wrote a web application for university entrance committees.
It seems to me that it is necessary to describe the possibilities or sequence of working with the program in the README.md file on the git.
For example: We create a faculty -> We register an applicant, and select a faculty and a specialty for him from those created earlier -> Exams are generated for the applicant based on his specialty -> we set marks for exams -> we look at the tab that shows the enrolled applicants, based on the number va places and grades for exams and a certificate.

Do I need to attach such a description somewhere? Well, or something like that.

Answer the question

In order to leave comments, you need to log in

1 answer(s)
P
Peter Bishop, 2021-02-25
@Peter_Bishop

There is a dedicated wiki section. True, it is doubtful that all this will be read, of course.

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question