]> git.armaanb.net Git - phrases.git/blobdiff - README.md
Fix README formatting
[phrases.git] / README.md
index 6541458918ec0d27ea828353cd8669f79d9d3a59..c8e3270b18bd3e9dc97779e16b3d96c728919664 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +1,19 @@
 # phrases
-Get latin famous phrases in your terminal!
+Get Latin famous phrases in the 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
+## Source of phrases
+There are currently 2239 phrases in the database, sourced from the Wikipedia page [List of Latin phrases (full)](https://en.wikipedia.org/w/index.php?title=List_of_Latin_phrases_(full)&oldid=986793908)
+
+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. 
 
 ## Installation
-`sudo make`
+`sudo make` to install.
+
+`sudo make uninstall` to uninstall completely.
 
-If you want to run the `extract.py` script, then you need BeautifulSoup
+### Notes
+  * If you want to regenerate the phrases.csv file with the `extract.py` script, then you need the BeautifulSoup Python module.
+  * Tested and written on Python 3.9.0
 
 ## License
-Phrases is MIT Licensed by [Armaan Bhojwani](https://armaanb.net), 2020. In part built on [fortune](https://github.com/bmc/fortune) by Brian M. Clapper
+Phrases is MIT Licensed by [Armaan Bhojwani](https://armaanb.net), 2020. See the LICENSE file for more information.