]> git.armaanb.net Git - phrases.git/blobdiff - README.md
Update README.md
[phrases.git] / README.md
index 95ffe8de0cb2440c0bdf31285ef24245e6d18479..73fcc134a0e94ee99ed8bd4911cc236aa6bf4619 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,22 +1,24 @@
 # phrases
 Latin famous phrases in the terminal
 
-## 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
-
 ## 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.  
+`sudo make install-extract` to install the `phrases-extract` script.  
+`sudo make uninstall` to uninstall completely.  
+`sudo make reinstall` to reinstall.  
 
-The program can also be run without installing
+The program can also be run without installing as well
 
-### Notes
-  * If you want to generate a new phrase database file with the `extract.py` script, then you need the beautifulsoup4 Python module.
+## 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 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.