https://github.com/jasongrace2282/knzhou
A tool to keep knzhou's physics handouts up to date
https://github.com/jasongrace2282/knzhou
cli olympiad physics rust
Last synced: 4 months ago
JSON representation
A tool to keep knzhou's physics handouts up to date
- Host: GitHub
- URL: https://github.com/jasongrace2282/knzhou
- Owner: JasonGrace2282
- Created: 2025-03-01T23:24:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-19T01:04:49.000Z (over 1 year ago)
- Last Synced: 2025-10-14T10:36:48.089Z (8 months ago)
- Topics: cli, olympiad, physics, rust
- Language: Rust
- Homepage:
- Size: 52.7 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Knzhou
A tool to keep [Kevin Zhou's](https://knzhou.github.io/) handouts up to date.
## Usage
Navigate to the directory of choice, and run
```
knzhou update
```
to install all handouts. To only install/update specific ones, do
```
knzhou update E3 # install E3
knzhou update E3Sol # install E3 solutions
```
### Changing the Config
`knzhou` has a system level config file located at `~/.config/knzhou/knzhou.toml` on Unix.
To get the location of the config file on your system, run `knzhou config get`.
#### Formatting Handout Names
In the `knzhou` config, there is a parameter called `format`. It uses the special
value `{handout}`, which is replaced with the name of the handout. For example,
to name `E3.pdf` as `handout-E3-best.pdf`, set it to the following
```toml
format = "handout-{handout}-best"
```
## Installation
Install [Rustup](https://www.rust-lang.org/tools/install), then run
```
rustup toolchain install 1.85 # or higher
cargo install --git https://github.com/JasonGrace2282/knzhou.git
```