X-Git-Url: https://git.armaanb.net/?p=phrases.git;a=blobdiff_plain;f=README.md;h=d6a43b7bbd7a6f576091e44d53b27ef59b8522a6;hp=08349ee253450a1ca84c40b1dc23b959c27fb8a2;hb=HEAD;hpb=9ffdc6ab29db2f90e880f31c9cb7c5febfda7818 diff --git a/README.md b/README.md index 08349ee..d6a43b7 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,17 @@ 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. This script requires the beautifulsoup4 Python module, it can be installed with `pip3 install -r requirements.txt`. -### Notes - * 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 +`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. @@ -19,4 +20,4 @@ Wikipedia contributors, "List of Latin phrases (full)," Wikipedia, The Free Ency 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.