X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=f13e0a169e2909f4458860872644f9c1c6ba82f1;hb=f03d1f1de5ed1c36fe3e27505653e669f01a59a3;hp=66c0625b5b048d6b449e4f5bc23f901d52daea93;hpb=c9ecbb88bfab85d5149d7b7681169d4855ebac4a;p=phrases.git diff --git a/README.md b/README.md index 66c0625..f13e0a1 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,19 @@ # phrases -Get Latin famous phrases in your terminal! +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. There are currently 2225 phrases in the database +## 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 2239 famous phrases in the database ## Installation -`sudo make` to install. Requires Python 3. +`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. +### Notes + * If you want to generate a new 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. 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