diff --git a/README.md b/README.md index 4bd0528..cc66e3e 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs-latex.md b/docs-latex.md index c713def..024ee3a 100644 --- a/docs-latex.md +++ b/docs-latex.md @@ -1,23 +1,25 @@ # LaTeX documentation -All LaTeX handouts are based on [`ormc_handout.cls`](./lib/tex/ormc_handout.cls). \ +All LaTeX handouts are based on [`handout.cls`](./lib/tex/handout.cls). \ This class is based on `article.cls`, and should work with most LaTeX packages. The best way to start a new document is to make a copy of an existing one. -- [Advanced/Cryptography](./src/Advanced/Cryptography) is a good example of a simple handout. -- [Advanced/DFAs](./src/Advanced/DFAs) is a good example of a handout with graphs. -- [Advanced/Geometric Optimization](./src/Advanced/Geometric%20Optimization) is a good example of a handout with geometry. +- [Advanced/Cryptography](./src/Advanced/Cryptography) is a good example of a simple handout. +- [Advanced/DFAs](./src/Advanced/DFAs) is a good example of a handout with graphs. +- [Advanced/Geometric Optimization](./src/Advanced/Geometric%20Optimization) is a good example of a handout with geometry. ## Notes -- Compile your handouts with XeLaTeX. \ - `pdflatex` is known to misbehave with `ormc_handout.cls`. \ - This will happen by default if you use vscode. \ - If you use Overleaf, you'll have to configure it manually (see document settings). + +- Compile your handouts with XeLaTeX. \ + `pdflatex` is known to misbehave with `handout.cls`. \ + This will happen by default if you use vscode. \ + If you use Overleaf, you'll have to configure it manually (see document settings). ## Document Options Document options are passed to `\documentclass`, as follows: + ```latex \documentclass[ % Show solutions is `solutions` is provided, @@ -37,49 +39,52 @@ Document options are passed to `\documentclass`, as follows: % This should only be used for single-page handouts % (e.g, warm-ups) nopagenumber -]{ormc_handout} +]{handout} ``` Use `geometry` to change margins and page dimensions. US letter is the default. - ## Utilities -- `\say{text}`: Puts text in quotes, handling details like period spacing. Courtesy of `dirtytalk`. -- `\note[Type]{text}`: Makes a note. -- `\hint{text}`: Shorthand for `\note[Hint]{text}` + +- `\say{text}`: Puts text in quotes, handling details like period spacing. Courtesy of `dirtytalk`. +- `\note[Type]{text}`: Makes a note. +- `\hint{text}`: Shorthand for `\note[Hint]{text}` ## Sections -The usual LaTeX title-customization techniques *WILL NOT WORK* with this class. \ +The usual LaTeX title-customization techniques _WILL NOT WORK_ with this class. \ Don't even try to load `titlesec`. -`ormc_handout.cls` supports two levels of sections: -- `\section`, for large parts of the handout -- `\definition`, `\theorem`, `\proposition`, `\example`, `\remark`, `\problem`, and `\problempart` +`handout.cls` supports two levels of sections: + +- `\section`, for large parts of the handout +- `\definition`, `\theorem`, `\proposition`, `\example`, `\remark`, `\problem`, and `\problempart` All these macros have the following syntax: `\problem{title}