From 358b3a546e37beb915d465a8eda3e4f3bf9934b2 Mon Sep 17 00:00:00 2001 From: colinelder Date: Mon, 18 Mar 2024 11:51:26 -0400 Subject: [PATCH] src readme --- src/README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/src/README.md b/src/README.md index 1f9735f..1465040 100644 --- a/src/README.md +++ b/src/README.md @@ -1,3 +1,13 @@ # All source code for the project is to be placed here -Special note: please be sure to mention any special setup procedures which are necessary to prepare the software for running. Such information should cover libraries and extraneous software to install in order to be able to run the software or artifact of this project. This discussion should also be placed in your Method Section. +The libraries needed for installation within this artifact are as follows: +They are ```os```, ```fuzzywuzzy```, and ```streamlit```. To install these run the following commands- + +```pip install streamlit``` +```pip install os``` +```pip install fuzzywuzzy``` + +From there, the program is ready to run! All the user needs to do is run the following command in the terminal, just be sure that you are located in the proper directory location before running the command. This is the ```src``` directory. The command is as follows: + +```streamlit run workingcode.py``` +