X-Git-Url: https://git.armaanb.net/?p=phrases.git;a=blobdiff_plain;f=README.md;h=f8468ae49e9c2a34c48c9d7f058674521b06f0bc;hp=66c0625b5b048d6b449e4f5bc23f901d52daea93;hb=7903f060595381a5cf3c94d71722aba6be5b1629;hpb=a1843720c7444be2e77d41bab8bd135015247002 diff --git a/README.md b/README.md index 66c0625..f8468ae 100644 --- a/README.md +++ b/README.md @@ -1,16 +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. There are currently 2225 phrases in the database +## 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` to install. Requires Python 3. + `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. +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. 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