diff --git a/readme.md b/readme.md index b5b1552bf3cf5ca5be88625ff84c31d42aad6a5b..4f978ae66cfaafb2a4b1cfbef47d00d5ba1cd837 100644 --- a/readme.md +++ b/readme.md @@ -4,3 +4,19 @@ ## Description Covers basic statistical measurements in data mining. + +## Installation +Must be using Python 3 or higher (recommended python 3.5 or higher). + +Recommended to use a Python Virtual Environment. For details, see +<https://git.brandon-rodriguez.com/python/example_projects/virtual_environments>. + +Once in the desired environment, open a terminal, cd to project root, and run `pip install -r requirements.txt`. + + +## Running the Program +Run the program from with your desired environment via `python ./main` while at the project root. + + +## References +See the `documents/references.md` file.