Provide a brief overview of your project here (aim for 2 to 5 paragraphs). Describe the project's core purpose, its main features, and a high-level overview of how it works.
You are highly encouraged to include a figure (e.g., a screenshot of the project running).
By convention, please place all images and other media assets in the assets folder (which has already been created for this purpose).
Tip for Students: If you need help formatting this document, check out the GitHub Markdown Guide or this handy Markdown Cheat Sheet. Don't forget to delete this note before submitting your project!
In this section, define both the project and repository architectures in their respective subsections below.
Provide a conceptual diagram explaining how the project works under the hood. Describe the main components, data flow, and technologies used.
Provide an overview of how the code is organized. A tree-like text structure is welcome here to explain the purpose of key directories and files.
Provide a step-by-step list of instructions required to configure and run the project.
- List any software, libraries, or tools required before running the code (e.g., Python 3.10, Node.js, Docker).
- Step one (e.g., clone the repository)
- Step two (e.g., install dependencies)
- Step three (e.g., command to run the application)
Describe the evaluation process conducted to verify that the project functions correctly. Plots and graphs are highly welcome to demonstrate the execution and performance of the project. At a minimum, you should include screenshots of the working solution.
Note: I will use this section to keep track of the grading for the projects.
| Component | Description | Value |
|---|---|---|
| Code quality | How well the project is coded and documented. | 0.2 |
| Repository quality | How well the repository is structured and organized. | 0.1 |
| Project functional | Whether the project achieves the desired objectives. | 0.3 |
| Solution quality | How effective and creative the solution is (AI-based solutions are penalized). | 0.3 |
| Additional features | If the students have added additional features not requested in the guide. | 0.1 |
List all students who worked on the project. For example:
## Authors
* [**Mário Antunes**](https://github.com/mariolpantunes)Add information regarding the project's license. By default, the MIT license is selected. Example below:
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.