X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=d6a43b7bbd7a6f576091e44d53b27ef59b8522a6;hb=a2c0f2555d239ca645957821205f10944bb9c4c8;hp=f8468ae49e9c2a34c48c9d7f058674521b06f0bc;hpb=7903f060595381a5cf3c94d71722aba6be5b1629;p=phrases.git diff --git a/README.md b/README.md index f8468ae..d6a43b7 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,23 @@ # phrases -Get Latin famous phrases in your terminal - -## 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 +Latin famous phrases in the terminal ## Installation -`sudo make` to install. Requires Python 3. +Clone the repository to get the development version, or get the latest release from [here](https://git.sr.ht/~armaan/phrases/refs) + +`sudo make install` to install the `phrases` script. + +`sudo make install-extract` to install the `phrases-extract` script. This script requires the beautifulsoup4 Python module, it can be installed with `pip3 install -r requirements.txt`. + +`sudo make uninstall` to uninstall completely + +`sudo make reinstall` to reinstall. + +The program can be run without installing as well, as it looks for the phrase database in the current working directory first. -`sudo make uninstall` to uninstall completely. +## 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. -If you want to regenerate the phrases.csv file with the `extract.py` script, then you need the BeautifulSoup Python module. +There are currently 2201 famous phrases in the database ## License -Phrases is MIT Licensed by [Armaan Bhojwani](https://armaanb.net), 2020. See the LICENSE file for more information. +Phrases is MIT Licensed by [Armaan Bhojwani](https://armaanb.net), 2021. See the LICENSE file for more information.