> Hi, > I was wondering in the readme requirements for the project, what does "describing the > design and development of the application" entail? > Are you looking for a kind of 'tour' of the website and how to use it?
> Thanks in advance!
That's half of it. The readme should:
a) tell someone how to deploy and use the application (how to run the application on
localhost, is sufficient, and a basic user manual giving an idea of how the application
works, and what is does).
b) tell other developers how to contribute to the project. Here you should probably give
a basic schema of the models used, describe the existing tests and how to run them, and
perhaps give an overview of API routes, if you used any.