aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnthony Wang2021-02-24 20:12:25 -0600
committerAnthony Wang2021-02-24 20:12:25 -0600
commit7e80bc30d52b053ed115195a6e0e133bc10b85fe (patch)
tree95a6d51b2a9208a60d74d28b95e5bf0e1066a45a
parent598731182b01cec364076b53c60139518fd5e627 (diff)
Update README
-rw-r--r--README.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/README.md b/README.md
index 9654744..aabd060 100644
--- a/README.md
+++ b/README.md
@@ -2,22 +2,31 @@
Resources for Science Olympiad Astronomy
+
## Guide
### Google Drive
Folder: https://drive.google.com/drive/folders/1tSWqSONcjwJWfYled2abuSCmDSUt4KiA?usp=sharing
+You should download it before contests since you technically can't use the internet during contests.
+
### Generate a binder
-You need to have Python 3 installed as well as `wkhtmltopdf`.
+`mkbinder.py` is a Python script to download web pages. It can detect if the latest version of a website is newer than the downloaded version and download only the web pages that need to be updated.
+
+You need to have [Python 3](https://www.python.org/downloads/) installed as well as [wkhtmltopdf](https://wkhtmltopdf.org/). You also need to be able to use the command line.
-Install dependencies: `pip install -r requirements.txt`
+First download this repository to your computer.
+
+Navigate to the folder in your terminal and run `pip install -r requirements.txt` to install dependencies.
Add links to download to text files in the `Links` folder. 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.
+Now run `./mkbinder.py`. It may take a while, depending on how many links to download.
+
+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}]