From 1594f31b90c2b8902a5c9d15f47f547a053cbca4 Mon Sep 17 00:00:00 2001 From: Brett Spaulding Date: Wed, 9 Aug 2023 16:09:41 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8a98e87..a658cc9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ # getDiscography -Flask based utility that will allow a user to download an entire Discography for the provided artist. \ No newline at end of file +Flask based utility that will allow a user to download an entire Discography for the provided artist. + +## How to use: + +Open the root directory of this project in a terminal. + +Create a virtual environment with python. +``` +python -m venv . +``` + +*For more about virtual environments, look here: https://docs.python.org/3/library/venv.html* + +While in the virtual env (venv) install the requirements.txt file with: +``` +pip install -r ./requirements.txt +``` + +After all dependencies have been installed successfully, start the service with: +``` +python app.py +``` + +The service will then be accessible at http://localhost for as long as the terminal stays open. To shutdown the service simply close the terminal or ctl + c \ No newline at end of file