Faculty of Engineering and Mathematical Sciences 
Not logged in (login)


This forum is provided to promote discussion amongst students enrolled in Agile Web Development (CITS3403).
RSS cloud
Jump to:

Readme file

1 of 419 articles shown, currently no other people reading this forum.
From: Timothy F.
Date: Mon 25th May 2020, 9:57am



> 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.

Related articles

Readme file (both) RSS
├─ original   Sun 24th May 2020, 4:15pm, ANONYMOUS
└─ THIS   Mon 25th May 2020, 9:57am, Timothy F.
This Page

Program written by: [email protected]
Feedback welcome
Last modified: 11:27am Sep 21 2020