One Paragraph of project description goes here
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
You will need to have a valid Python installation on your system. This has been tested with Python 3.6. It does not assume a particulay version of python, however, it makes no assertions of proper working, either on this version of Python, or on another.
The folloiwing installations are for *nix-like systems.
For installation, first close this repository, and generate the virtual environment required for running the programs.
This project framework uses venv for maintaining virtual environments. Please familiarize yourself with venv before working with this repository. You do not want to contaminate your system python while working with this repository.
A convenient script for doing this is present in the file bin/vEnv.sh. This is automatically do the following things:
- Generate a virtual environment
- activate this environment
- install all required libraries
- deactivate the virtual environment and return to the prompt.
At this point you are ready to run programs. However, remember that you will need to activate the virtual environment any time you use the program.
For activating your virtual environment, type source env/bin/activate in the project folder in bash or source env/bin/activate.fish if you are using the fish shell.
For deactivating, just type deactivate in your shell
Add additional notes about how to deploy this on a live system
- Python 3.6
Please send in a pull request.
madelinelim - Initial work (2021)
This project is licensed under the MIT License - see the LICENSE.txt file for details
- Hat tip to anyone who's code was used
- Inspiration
- etc.