Skip to content

Latest commit

 

History

History
32 lines (28 loc) · 1019 Bytes

README.md

File metadata and controls

32 lines (28 loc) · 1019 Bytes

Knzhou

A tool to keep Kevin Zhou's 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

format = "handout-{handout}-best"

Installation

Install Rustup, then run

rustup toolchain install 1.85  # or higher
cargo install --git https://github.com/JasonGrace2282/knzhou.git