]> git.armaanb.net Git - phrases.git/commitdiff
Update README
authorArmaan Bhojwani <me@armaanb.net>
Sun, 24 Jan 2021 18:36:53 +0000 (13:36 -0500)
committerArmaan Bhojwani <me@armaanb.net>
Sun, 24 Jan 2021 18:36:53 +0000 (13:36 -0500)
README.md

index c8682af93679768c7338dfcc52c1604b83f41171..d6a43b7bbd7a6f576091e44d53b27ef59b8522a6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,17 +6,13 @@ Clone the repository to get the development version, or get the latest release f
 
 `sudo make install` to install the `phrases` script.
 
-`sudo make install-extract` to install the `phrases-extract` 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 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
+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. 
@@ -24,4 +20,4 @@ Wikipedia contributors, "List of Latin phrases (full)," Wikipedia, The Free Ency
 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.
+Phrases is MIT Licensed by [Armaan Bhojwani](https://armaanb.net), 2021. See the LICENSE file for more information.