aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAnthony Wang2021-02-24 20:17:03 -0600
committerAnthony Wang2021-02-24 20:17:03 -0600
commit9fc455d70f69a6dc63ce967989d22f5bae4de653 (patch)
tree9e0b78abb21457adad69d43c2d1d85f41c47b7f8 /README.md
parent077a18268097db843f500527bd702751af13683a (diff)
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index aabd060..a051e29 100644
--- a/README.md
+++ b/README.md
@@ -26,14 +26,18 @@ Add links to download to text files in the `Links` folder. The links in each tex
Now run `./mkbinder.py`. It may take a while, depending on how many links to download.
+Spam Ctrl-C in your terminal to quit the script while it's running.
+
You can change the backend used to download the websites, but the default backend `pdfkit` tends to work the best and is recommended. There is an alternative backend `weasyprint` which may work better in some cases and does not require wkhtmltopdf. Only change the backend if you are having trouble with the default and you know what you are doing!
```
-usage: mkbinder.py [-h] [--backend {pdfkit,weasyprint}]
+usage: mkbinder.py [-h] [--backend {pdfkit,weasyprint}] [--force {False,True}]
optional arguments:
-h, --help show this help message and exit
--backend {pdfkit,weasyprint}, -b {pdfkit,weasyprint}
change the download backend; default: pdfkit
+ --force {False,True}, -f {False,True}
+ force download all links instead of only the ones that need to be updated; default: False
```