]> git.armaanb.net Git - phrases.git/blobdiff - README.md
make database-file location more flexible
[phrases.git] / README.md
index c8e3270b18bd3e9dc97779e16b3d96c728919664..95ffe8de0cb2440c0bdf31285ef24245e6d18479 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,18 +1,21 @@
 # phrases
-Get Latin famous phrases in the terminal
-
-## Source of phrases
-There are currently 2239 phrases in the database, sourced from the Wikipedia page [List of Latin phrases (full)](https://en.wikipedia.org/w/index.php?title=List_of_Latin_phrases_(full)&oldid=986793908)
+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.
 
 `sudo make uninstall` to uninstall completely.
 
+The program can also be run without installing
+
 ### Notes
-  * If you want to regenerate the phrases.csv file with the `extract.py` script, then you need the BeautifulSoup Python module.
+  * If you want to generate a new phrase database file with the `extract.py` script, then you need the beautifulsoup4 Python module.
   * Tested and written on Python 3.9.0
 
 ## License