X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=c8682af93679768c7338dfcc52c1604b83f41171;hb=e5acff67b4bc87ebc4415e5cfc8879ced20ea0b2;hp=8b47a328a7610180f331385b876885828a390000;hpb=5c38e900ada8915ded1a0b4e568d88327b64ea35;p=phrases.git diff --git a/README.md b/README.md index 8b47a32..c8682af 100644 --- a/README.md +++ b/README.md @@ -2,21 +2,26 @@ Latin famous phrases in the terminal ## Installation -### On Linux + MacOS -`sudo make` to install. +Clone the repository to get the development version, or get the latest release from [here](https://git.sr.ht/~armaan/phrases/refs) -`sudo make uninstall` to uninstall completely. +`sudo make install` to install the `phrases` script. -The program can also be run without installing +`sudo make install-extract` to install the `phrases-extract` script. -### Notes - * If you want to generate a new phrase database file with the `extract.py` script, then you need the beautifulsoup4 Python module. +`sudo make uninstall` to uninstall completely + +`sudo make reinstall` to reinstall. + +The program can also be run without installing as well + +## Notes + * The `extract.py` script (installed in $PATH as `phrases-extract`) requires 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 +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.