]> git.armaanb.net Git - phrases.git/blobdiff - README.md
Bump version number in manpages
[phrases.git] / README.md
index 08349ee253450a1ca84c40b1dc23b959c27fb8a2..c8682af93679768c7338dfcc52c1604b83f41171 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,15 +2,20 @@
 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.
 
-### Notes
-  * If you want to generate a new phrase database file with the `extract.py` script, then you need the beautifulsoup4 Python module.
+`sudo make uninstall` to uninstall completely
+
+`sudo make reinstall` to reinstall.
+
+The program can also be run without installing as well
+
+## 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