X-Git-Url: https://git.armaanb.net/?p=phrases.git;a=blobdiff_plain;f=README.md;h=d6a43b7bbd7a6f576091e44d53b27ef59b8522a6;hp=66c0625b5b048d6b449e4f5bc23f901d52daea93;hb=HEAD;hpb=c9ecbb88bfab85d5149d7b7681169d4855ebac4a diff --git a/README.md b/README.md index 66c0625..d6a43b7 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,23 @@ # phrases -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 +Latin famous phrases in the terminal ## Installation -`sudo make` to install. Requires Python 3. -`sudo make uninstall` to uninstall completely. +Clone the repository to get the development version, or get the latest release from [here](https://git.sr.ht/~armaan/phrases/refs) -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. +`sudo make install` to install the `phrases` script. -## License -Phrases is MIT Licensed by [Armaan Bhojwani](https://armaanb.net), 2020. See the LICENSE file for more information. +`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. -In part built on [fortune](https://github.com/bmc/fortune) by Brian M. Clapper which is BSD licensed +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. + +There are currently 2201 famous phrases in the database + +## License +Phrases is MIT Licensed by [Armaan Bhojwani](https://armaanb.net), 2021. See the LICENSE file for more information.