Make manconvert smarter

[phrases.git] / README.md

diff --git a/README.md b/README.md
index 6541458918ec0d27ea828353cd8669f79d9d3a59..d6a43b7bbd7a6f576091e44d53b27ef59b8522a6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +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
+Latin famous phrases in the terminal
 
 ## Installation
-`sudo make`
+Clone the repository to get the development version, or get the latest release from [here](https://git.sr.ht/~armaan/phrases/refs)
+
+`sudo make install` to install the `phrases` script.
+
+`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.
+
+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. 
 
-If you want to run the `extract.py` script, then you need BeautifulSoup
+There are currently 2201 famous phrases in the database
 
 ## License
-Phrases is MIT Licensed by [Armaan Bhojwani](https://armaanb.net), 2020. In part built on [fortune](https://github.com/bmc/fortune) by Brian M. Clapper
+Phrases is MIT Licensed by [Armaan Bhojwani](https://armaanb.net), 2021. See the LICENSE file for more information.