Add phrases-extract manpage

[phrases.git] / README.md

diff --git a/README.md b/README.md
index 66c0625b5b048d6b449e4f5bc23f901d52daea93..b38c18097d989810f2d73ee8e73b0d63222c3d3f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,16 +1,22 @@
 # phrases
-Get Latin famous phrases in your terminal!
-
-## Source
-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` to install.
+
 `sudo make uninstall` to uninstall completely.
 
-If you want to run the `extract.py` script, then you need the BeautifulSoup Python module. This is not needed for installation however, as this repository has a pre-extracted list of phrases [here](phrases). If the repository has not been updated in some time, then it may be prudent to run it again to get a fresh list. You can do this at install-time with `sudo make extract-install`. As this is run as root, make sure to install BeautifulSoup globally.
+The program can also be run without installing as well
+
+### Notes
+  * The `extract.py` script requires the beautifulsoup4 Python module.
+  * Tested and written on Python 3.9.0
+
+## 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. 
+
+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.
-
-In part built on [fortune](https://github.com/bmc/fortune) by Brian M. Clapper which is BSD licensed