Clean up README and remove GDrive and rclone sections

This commit is contained in:
Anthony Wang 2022-01-22 21:00:18 -06:00
parent 812a271f92
commit d7e6ccb5be
Signed by: a
GPG key ID: BC96B00AEC5F2D76

View file

@ -3,55 +3,28 @@
Resources for Science Olympiad Astronomy. Note that due to the [license](LICENSE), **you must publicly release any code that you use from this repository**.
## Guide
## Usage
### Install dependencies
You can install all the required dependencies on Arch Linux with `cat packages.txt | xargs sudo pacman -S --asdeps --noconfirm`. For other Linux distros, install your distro's version of the packages in `packages.txt`.
### Kiwix
### Google Drive
Download all of Wikipedia, or if you are low on disk space, Wikipedia Astronomy.
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.
### rclone
You can copy the Google Drive folder to your computer with `rclone copy "drive:Science/Science Olympiad 20.5/Astronomy 20.5/Astro 2021" . --exclude="General/Hyperphysics English.zip" -P`.
You can copy your files to the Google Drive with `rclone copy . "drive:Science/Science Olympiad 20.5/Astronomy 20.5/Astro 2021" --exclude="astropy/**" --exclude=".git/**" --exclude=".venv/**" --exclude="General/hbase/**" -P`.
## Kiwix
Download all of Wikipedia, or optionally, Wikipedia Astronomy.
## Speedcrunch
### Speedcrunch
Great for unit conversions: https://speedcrunch.org/userguide/advanced.html
### Astropy
## Astropy
First, clone the submodule with `git submodule init && git submodule update --remote`. Then [build the documentation](https://github.com/astropy/astropy/blob/main/docs/install.rst#building-documentation).
For advanced users, you will definitely want to build the documentation: https://github.com/astropy/astropy/blob/main/docs/install.rst#building-documentation
### Wikipedia
You can download Wikipedia using [Kiwix](https://www.kiwix.org/en/). It should be more than enough for regionals and state.
### Generate a binder
### Download web pages
`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.
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.