Replace "ORMC" with generic "handout"

This commit is contained in:
2025-03-02 14:18:25 -08:00
parent a4e5a065b0
commit acf57ceab6
57 changed files with 152 additions and 138 deletions

View File

@ -1,7 +1,7 @@
[tinymist]: https://marketplace.visualstudio.com/items?itemName=myriad-dreamin.tinymist
[latex-workshop]: https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop
[CC BY-NC-SA 4.0]: https://creativecommons.org/licenses/by-nc-sa/4.0
[betalupi.com/handouts]: https://static.betalupi.com/ormc
[betalupi.com/handouts]: https://betalupi.com/handouts
[ORMC]: https://circles.math.ucla.edu/circles/
[Overleaf]: https://overleaf.com
[Typst.app]: https://typst.app
@ -26,7 +26,7 @@ By submitting or editing a handout in this repository, you agree to release it u
## 🛠️ Contributing
If you want to use one of these handouts for a class, see [`betalupi.com/handouts`](https://betalupi.com/handouts). \
If you want to use one of these handouts for a class, see [betalupi.com/handouts]. \
You only need to read this section if you want to edit these handouts.
### Setup
@ -56,7 +56,7 @@ This repository is organized as follows:
- [`./tools`](./tools) contains build scripts, [`./.github`](./.github) configures automation. \
You can ignore everything in these directories.
All handouts in this repository are based on `ormc_handout.cls` or `handout@0.1.0`.
All handouts in this repository are based on `handout.cls` or `handout@0.1.0`.
- If you're using Typst (preferred), read [`docs-typst.md`](./docs-typst.md)
- If you're still using LaTeX, read [`docs-latex.md`](./docs-latex.md).
@ -95,8 +95,8 @@ _(I do not recommend this. The default toolchain makes it easier to share improv
### For LaTeX:
1. Get the handout's directory (i.e, download the whole repo as a zip and extract the folder you want.)
2. Download [`./resources/ormc_handout.cls`](./resources/ormc_handout.cls)
3. Put this `ormc_handout.cls` in the same directory as the handout.
2. Download [`./resources/handout.cls`](./resources/handout.cls)
3. Put this `handout.cls` in the same directory as the handout.
4. Fix the include path at the top of `main.tex`:
You'll need to replace
@ -104,7 +104,7 @@ You'll need to replace
```latex
\documentclass[
...
]{../../../lib/tex/ormc_handout}
]{../../../lib/tex/handout}
```
with
@ -112,11 +112,11 @@ with
```latex
\documentclass[
...
]{ormc_handout}
]{handout}
```
5. Make a new overleaf project with the resulting directory.
6. **Do not use pdflatex**, it misbehaves with `ormc_handout`. Tell Overleaf to use XeLaTeX.
6. **Do not use pdflatex**, it misbehaves with `handout`. Tell Overleaf to use XeLaTeX.
### For Typst:
@ -124,5 +124,5 @@ Out-of-band typst compilation isn't supported. Clone the repository and use vsco
This is because typst can't import packages from a relative path.
If you _really_ want it, standalone typst compilation _is_ possible. \
Follow the LaTeX instructions, but fix `handout@0.1.0` instead of `ormc_handout`. \
Follow the LaTeX instructions, but fix `handout@0.1.0` instead of `handout`. \
You'll figure it out.