Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.3 KB

File metadata and controls

37 lines (23 loc) · 1.3 KB

Math Assignments and Presentations

GitHub Workflow Status

Various papers and presentations done in LaTeX. Links to compiled PDFs can be found in the READMEs.

Contributing

Set up local linting

sudo apt install python3-tk python3-venv
python -m venv .venv
source .venv/bin/activate

Linting is done with pre-commit, a multi-language package manager for pre-commit hooks.

Follow the instructions at https://pre-commit.com/#install to install it, then run pre-commit install in the repo root to install the git hooks locally. They will run automatically every time you commit.

If you want to run all the checks manually, use pre-commit run --all-files. If you want to run just one of the checks, use pre-commit run <hook_id>.

All the hooks are also run automatically via CI when pushing, so installing them locally will save you from realizing you made a mistake only after pushing.

Installing dependencies

On Ubuntu, run scripts/install.sh to install dependencies.

Makefile Usage

Makefile is used to simplify the steps needed to build and clean the repository. See commands below for usage:

make build
make clean
make upload