X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=8b47a328a7610180f331385b876885828a390000;hb=5c38e900ada8915ded1a0b4e568d88327b64ea35;hp=38dcb0835270466b5eb81a323b47869ca684dd3e;hpb=3e4ee2d1a36d23079d68d3dda8b004bbd7cc8106;p=phrases.git diff --git a/README.md b/README.md index 38dcb08..8b47a32 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,22 @@ # phrases -Get Latin famous phrases in the terminal - -## 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. (2020, November 3). List of Latin phrases (full). In Wikipedia, The Free Encyclopedia. Retrieved 20:22, December 2, 2020, from https://en.wikipedia.org/w/index.php?title=List_of_Latin_phrases_(full)&oldid=986793908 +Latin famous phrases in the terminal ## Installation +### On Linux + MacOS `sudo make` to install. `sudo make uninstall` to uninstall completely. +The program can also be run without installing + ### Notes - * If you want to regenerate the phrases.csv file with the `extract.py` script, then you need the BeautifulSoup Python module. + * If you want to generate a new phrase database file with the `extract.py` script, then you need 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 2239 famous phrases in the database + ## License Phrases is MIT Licensed by [Armaan Bhojwani](https://armaanb.net), 2020. See the LICENSE file for more information.