]> git.armaanb.net Git - phrases.git/blob - README.md
Fix style according to Flake8
[phrases.git] / README.md
1 # phrases
2 Latin famous phrases in the terminal
3
4 ## Installation
5 Clone the repository to get the development version, or get the latest release from [here](https://git.sr.ht/~armaan/phrases/refs)
6
7 `sudo make install` to install the `phrases` script.
8
9 `sudo make install-extract` to install the `phrases-extract` script.
10
11 `sudo make uninstall` to uninstall completely
12
13 `sudo make reinstall` to reinstall.
14
15 The program can also be run without installing as well
16
17 ## Notes
18   * The `extract.py` script (installed in $PATH as `phrases-extract`) requires the beautifulsoup4 Python module
19   * Tested and written on Python 3.9.0
20
21 ## Source of famous phrases
22 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. 
23
24 There are currently 2201 famous phrases in the database
25
26 ## License
27 Phrases is MIT Licensed by [Armaan Bhojwani](https://armaanb.net), 2020. See the LICENSE file for more information.