Skip to content

Commit

Permalink
src readme
Browse files Browse the repository at this point in the history
  • Loading branch information
colinelder committed Mar 18, 2024
1 parent 35d422d commit 358b3a5
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion src/README.md
Original file line number Diff line number Diff line change
@@ -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```

0 comments on commit 358b3a5

Please sign in to comment.