aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAnthony Wang2020-11-27 19:09:07 -0600
committerAnthony Wang2020-11-27 19:09:07 -0600
commit4abae31b34c35236115aa994576bd66d7dce3568 (patch)
tree07318b2e8bdd30db117cba62ad488a25f3546da9 /README.md
parent47e6933a6a142040caa615f524aa6336c5f37385 (diff)
Add backends arg
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 29 insertions, 1 deletions
diff --git a/README.md b/README.md
index 3477235..f627a61 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,30 @@
# Astronomy
-Science Olympiad Astronomy
+
+Resources for Science Olympiad Astronomy
+
+## Guide
+
+### Google Drive
+
+Folder: https://drive.google.com/drive/folders/1tSWqSONcjwJWfYled2abuSCmDSUt4KiA?usp=sharing
+
+
+### Generate a binder
+
+You need to have Python 3 installed.
+
+Install dependencies: `pdfkit`, `weasyprint`, `wkhtmltopdf`
+
+Add links to download to text files. The links in each text file will be downloaded to their own folder.
+
+Run `./mkbinder.py`. It may take a while, depending on how many links to download.
+
+```
+usage: mkbinder.py [-h] [--backend {pdfkit,weasyprint}]
+
+optional arguments:
+ -h, --help show this help message and exit
+ --backend {pdfkit,weasyprint}, -b {pdfkit,weasyprint}
+ change the download backend; default: pdfkit
+```
+