README.md

COMP0035 Coursework 1 template repository

This repository contains a basic structure for coursework 1 and optionally may also be used for coursework 2.

Instructions for using the starter code

To set up your project:

1. Clone this repository in your IDE (e.g. PyCharm, Visual Studio Code) from GitHub. Follow the help in your IDE e.g. clone a GitHub repo in PyCharm.
2. Add a virtual environment (venv). Use the instructions for your IDE or navigate to your project directory and use python.
3. Install the requirements from requirements.txt. Use the instructions for your IDE or use python in your shell..
4. Edit .gitignore to add any config files and folders for your IDE. PyCharm, VisualStudio Code, Xcode and NetBeans have already been added.
5. comp0035_coursework1.md contains an outline structure of a document that you can use to write coursework 1.
6. comp0035_coursework2.md contains an outline structure of a document that you can use to write coursework 2. Alternatively there is a separate assignment in GitHub classroom if you prefer to separate coursework 1 and 2.

Before you submit the coursework:

1. Replace this README.md with comp0035_coursework1.md.
2. Update requirements.txt with the libraries used in your project.
3. Download the repository as a zip file from GitHub. Upload the zip file to Moodle in the coursework 1 submission assignment.