From 83bf81ab46e734eeb44683a09bc6e890f9373d3e Mon Sep 17 00:00:00 2001 From: Adam McGuigan <31741286+apmcguigan@users.noreply.github.com> Date: Tue, 28 Apr 2020 13:39:28 -0300 Subject: [PATCH] Update readme --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index f2b9b83..473bff1 100644 --- a/README.md +++ b/README.md @@ -12,14 +12,21 @@ The project is written with Python 3.7. The PyQt GUI framework is used to create - Search the sqlite database of fetched and imported reports - Generate charts using the data in the database -## Download Project -https://git.library.upei.ca/mbelvadi/COUNTER-5-Report-Tool/releases +## Developer Contact Info +- Adam McGuigan apmcguigan@upei.ca +- Chandler Acorn cjacorn@upei.ca +- Samuel Esan sesan@upei.ca +- Urvesh Boodhun uboodhun@upei.ca +- Ziheng Huang Zihhuang@upei.ca + +## Download Project +https://github.com/CS-4820-Library-Project/COUNTER-5-Report-Tool/releases ## Developer Documentation https://counter-5-report-tool.readthedocs.io/en/latest/ ## How to use pyinstaller for executables -https://git.library.upei.ca/mbelvadi/COUNTER-5-Report-Tool/src/master/docs/pyinstaller-how-to.md +https://github.com/CS-4820-Library-Project/COUNTER-5-Report-Tool/blob/master/docs/pyinstaller-how-to.md ## Setup Instructions (Windows) - Install Python 3.8.2 [https://www.python.org/ftp/python/3.8.2/python-3.8.2-amd64.exe] @@ -30,15 +37,15 @@ https://git.library.upei.ca/mbelvadi/COUNTER-5-Report-Tool/src/master/docs/pyins - Click Browse - Browse to where python is downloaded, by default: C:\Users\USER_NAME\AppData\Local\Programs\Python\Python38 -- Add another variable in the same way that we just did. +- Add another variable in the same way that we just did. - Except this time set the filepath to C:\Users\apjm4\AppData\Local\Programs\Python\Python38\Scripts -Python should now be accessible in Windows Command Prompt. +Python should now be accessible in Windows Command Prompt. Open command prompt and type Python --version. This should return the version of python that is installed. If not the path may be wrong or python was not installed correctly. type pip -v into command prompt, this should return the version of PIP that is installed with Python. -### Download the project from Gitea +### Download the project from Github - Close and re-open command prompt - type cd - Open the location you downloaded the project to and drag the folder into the command prompt window @@ -71,5 +78,3 @@ type pip -v into command prompt, this should return the version of PIP that is i - Choose Existing environment and set the location to anaconda_install_location/python.exe, OK, OK - Allow the IDE to complete set up then launch the program from MainDriver.py. There should be a play icon next to the line "if __name__ == "__main__":" - We Good To Go! - -