[TASK 1.5.3] Write and format the README.md file with project details

[catapam]

Create a comprehensive README.md file that outlines the project’s purpose, setup instructions, usage guidelines, and other relevant details.

Acceptance Criteria:

• [x] The README.md file includes sections on project overview, setup instructions, usage, and contributing.
• [ ] The file is well-formatted with markdown, making it easy to read and navigate.
• [x] The README is kept up-to-date with any project changes.

Steps:

1. Draft the content for the README.md file, covering all essential aspects of the project.
2. Format the README using markdown for clarity and ease of navigation.
3. Include sections for project overview, setup instructions, usage, and contribution guidelines.
4. Review the README for accuracy and completeness.
5. Update the README regularly as the project evolves.

Linked Issues:

• 105

• 110

• Documentation: README.md File Documentation

Next task:

• 135

Previous task:

• 133

[catapam]

Initiated template and documented the expected for the project + plannign (agile methodology and planning) section of the document. This will be editted again in the future

Commit