Add extract.py script to Makefile

[phrases.git] / README.md

diff --git a/README.md b/README.md
index f8468ae49e9c2a34c48c9d7f058674521b06f0bc..8ceb3590272745391fe93435caf90a7c47b12fb2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,15 +1,23 @@
 # phrases
-Get Latin famous phrases in your terminal
-
-## Source of phrases
-The Wikipedia page [List of Latin phrases (full)](https://en.wikipedia.org/wiki/List_of_Latin_phrases_(full)). See the references [here](https://en.wikipedia.org/wiki/List_of_Latin_phrases_(full)#References) for more information. There are currently 2225 phrases in the database
+Latin famous phrases in the terminal
 
 ## Installation
-`sudo make` to install. Requires Python 3.
+### On Linux + MacOS
+`sudo make install` to install the `phrases` script.  
+`sudo make install-extract` to install the `phrases-extract` script.  
+`sudo make uninstall` to uninstall completely.  
+`sudo make reinstall` to reinstall.  
+
+The program can also be run without installing as well
+
+### Notes
+  * The `extract.py` script (installed in $PATH as `phrases-extract`) requires the beautifulsoup4 Python module
+  * Tested and written on Python 3.9.0
 
-`sudo make uninstall` to uninstall completely.
+## Source of famous phrases
+Wikipedia contributors, "List of Latin phrases (full)," Wikipedia, The Free Encyclopedia, https://en.wikipedia.org/w/index.php?title=List_of_Latin_phrases_(full)&oldid=986793908. 
 
-If you want to regenerate the phrases.csv file with the `extract.py` script, then you need the BeautifulSoup Python module. 
+There are currently 2201 famous phrases in the database
 
 ## License
 Phrases is MIT Licensed by [Armaan Bhojwani](https://armaanb.net), 2020. See the LICENSE file for more information.