From 2acb1b51da9b463c4dfde07be8c454e46a97089f Mon Sep 17 00:00:00 2001 From: Brandon Rodriguez <brodriguez8774@gmail.com> Date: Sun, 17 May 2020 09:38:06 -0400 Subject: [PATCH] Update readme --- readme.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/readme.md b/readme.md index b5b1552..4f978ae 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. -- GitLab