Browse Source

Update readme

master
Adam McGuigan 5 years ago
parent
commit
83bf81ab46
  1. 15
      README.md

15
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 - Search the sqlite database of fetched and imported reports
- Generate charts using the data in the database - Generate charts using the data in the database
## 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 ## Download Project
https://git.library.upei.ca/mbelvadi/COUNTER-5-Report-Tool/releases https://github.com/CS-4820-Library-Project/COUNTER-5-Report-Tool/releases
## Developer Documentation ## Developer Documentation
https://counter-5-report-tool.readthedocs.io/en/latest/ https://counter-5-report-tool.readthedocs.io/en/latest/
## How to use pyinstaller for executables ## 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) ## Setup Instructions (Windows)
- Install Python 3.8.2 [https://www.python.org/ftp/python/3.8.2/python-3.8.2-amd64.exe] - Install Python 3.8.2 [https://www.python.org/ftp/python/3.8.2/python-3.8.2-amd64.exe]
@ -38,7 +45,7 @@ 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. 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 - Close and re-open command prompt
- type cd - type cd
- Open the location you downloaded the project to and drag the folder into the command prompt window - 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 - 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__":" - 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! - We Good To Go!

Loading…
Cancel
Save