]> git.armaanb.net Git - phrases.git/blobdiff - README.md
change to CSV instead of fortune-style database
[phrases.git] / README.md
index 6541458918ec0d27ea828353cd8669f79d9d3a59..f8468ae49e9c2a34c48c9d7f058674521b06f0bc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +1,15 @@
 # phrases
-Get latin famous phrases in your terminal!
+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
+## 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
 
 ## Installation
-`sudo make`
+`sudo make` to install. Requires Python 3.
 
-If you want to run the `extract.py` script, then you need BeautifulSoup
+`sudo make uninstall` to uninstall completely.
+
+If you want to regenerate the phrases.csv file with the `extract.py` script, then you need the BeautifulSoup Python module. 
 
 ## 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.