X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=d6a43b7bbd7a6f576091e44d53b27ef59b8522a6;hb=a2c0f2555d239ca645957821205f10944bb9c4c8;hp=f13e0a169e2909f4458860872644f9c1c6ba82f1;hpb=f03d1f1de5ed1c36fe3e27505653e669f01a59a3;p=phrases.git diff --git a/README.md b/README.md index f13e0a1..d6a43b7 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,23 @@ # phrases Latin famous phrases in the terminal -## 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. +## Installation +Clone the repository to get the development version, or get the latest release from [here](https://git.sr.ht/~armaan/phrases/refs) -There are currently 2239 famous phrases in the database +`sudo make install` to install the `phrases` script. -## Installation -`sudo make` to install. +`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 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. + +## 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. -### 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 +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.