Global: Documentation

[arnard76]

Notes that are passed over so that project can be understood by next team.

Might also include credentials for the services used e.g. stuff we have included in environment variables?

[arnard76]

@HuzzNZ feel free to assign yourself if you wanna have a crack at this one

[arnard76]

This includes the handover document #249

but if anything else needs to be documented as well we can create more subtasks here

[arnard76]

Readme requirements @arnard76

https://canvas.auckland.ac.nz/courses/104282/assignments/375295

The README file in your repo must be updated to include the following information:

Name of the project.
A link to your Project Management tool.
A short description of what the project is about. (You may put a link to your final report here, after it has been completed).
Technologies that are used to build the project (include the languages used, the libraries and their versions).
Instructions on how to install and setup the project (specify all dependencies).
Usage Examples (if available).
URL of the website where the project has been deployed (if applicable).
Future Plan (Ideas for future releases)
Acknowledgements (if any) - You can list tutorials used, projects referred to, people consulted etc.

[arnard76]

The README file in your repo must be updated to include the following information:

• Name of the project.
• A link to your Project Management tool.
• A short description of what the project is about. (You may put a link to your final report here, after it has been completed).
• Technologies that are used to build the project (include the languages used, the libraries and their versions).
• Instructions on how to install and setup the project (specify all dependencies).
• Usage Examples (if available).
• URL of the website where the project has been deployed (if applicable).
• Future Plan (Ideas for future releases)
• Acknowledgements (if any) - You can list tutorials used, projects referred to, people consulted etc.

[arnard76]

[arnard76]

[arnard76]

don't delete these comments with the images as they are used in the readme :)

[HuzzNZ]

don't delete these comments with the images as they are used in the readme :)

These didn't render properly on the readme, but i didn't think it was too necessary anyways. A good description is enough, the markers know more about this stuff than we do anyways. If you still want to include it then upload it to an external host like imgur or place the images directly into the repo.

[arnard76]

weird, they rendered fine for me
https://github.com/uoa-compsci399-s1-2024/capstone-project-2024-s1-team-15/blob/6d7881f75c6629f2b577d4560d8fba6a3f9cf517/README.md

[HuzzNZ]

weird, they rendered fine for me https://github.com/uoa-compsci399-s1-2024/capstone-project-2024-s1-team-15/blob/6d7881f75c6629f2b577d4560d8fba6a3f9cf517/README.md