]> git.armaanb.net Git - phrases.git/blobdiff - README.md
update formatting and convinience
[phrases.git] / README.md
index 6541458918ec0d27ea828353cd8669f79d9d3a59..66c0625b5b048d6b449e4f5bc23f901d52daea93 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +1,16 @@
 # 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
+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.
+`sudo make uninstall` to uninstall completely.
 
-If you want to run the `extract.py` script, then you need BeautifulSoup
+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.
 
 ## 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.
+
+In part built on [fortune](https://github.com/bmc/fortune) by Brian M. Clapper which is BSD licensed