mirror of
https://github.com/prdlk/cv.git
synced 2026-08-02 17:31:41 +00:00
43 lines
3.2 KiB
Markdown
43 lines
3.2 KiB
Markdown
# CLAUDE.md
|
|
|
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
|
|
## What this is
|
|
|
|
A single-page, two-asymmetric-column LaTeX resume template (Deedy-Resume, OpenFonts variant). The content lives in one `.tex` file; styling lives in one `.cls` file; publications come from a `.bib` file via BibTeX.
|
|
|
|
## Build
|
|
|
|
Must compile with **XeLaTeX**, not pdflatex — the template uses `fontspec` to load the bundled OTFs in `fonts/lato/` and `fonts/raleway/` by path. All commands must run from the repo root so those relative paths resolve.
|
|
|
|
```bash
|
|
make # one-shot build → dist/deedy_resume-openfont.pdf
|
|
make watch # latexmk -pvc: rebuild + live-preview on every save (dev mode)
|
|
make preview # build once and open the PDF
|
|
make clean # remove LaTeX aux files, keep the PDF
|
|
make distclean # remove dist/ entirely
|
|
```
|
|
|
|
Under the hood `make` calls `latexmk -xelatex` with `-output-directory=dist`, which handles the bibtex passes for `publications.bib` automatically. There is no CI or linter — the only "test" is that the PDF compiles and stays one page (see Layout constraint below).
|
|
|
|
## Architecture
|
|
|
|
- **`deedy-resume-openfont.cls`** — document class. Defines colors, font face mappings (Lato + Raleway loaded from relative `fonts/` paths via `fontspec`), and the custom commands the `.tex` file calls: `\namesection`, `\runsubsection`, `\descript`, `\location`, `\sectionsep`, and the `tightemize` environment. Edit this file for styling/typography; edit the `.tex` for content.
|
|
- **`deedy_resume-openfont.tex`** — content. Note the filename uses an underscore while the class file uses a hyphen — this asymmetry is intentional, don't "fix" it. The two columns are a `minipage` pair (`0.33\textwidth` left, `0.66\textwidth` right) separated by `\hfill`.
|
|
- **`publications.bib`** — entries cited via `\nocite{*}` in the Publications section.
|
|
- **`fonts/`** — bundled OTFs. The `.cls` references them by relative path, so the working directory at build time must be the repo root.
|
|
|
|
## Layout constraint
|
|
|
|
The template is **single-page by design** and silently overflows to a second page if either column gets too long (documented in README "Known Issues"). When adding content, mentally budget against the existing column length and prefer trimming over adding. The `\sectionsep` (8pt) and `tightemize` (a tightened `itemize`) exist specifically to claw back vertical space.
|
|
|
|
## Known quirks to leave alone
|
|
|
|
- `deedy_resume-openfont.tex` ends with a stray `\documentclass[]{article}` *after* `\end{document}` (line 249). It's ignored by the compiler and is a long-standing artifact of the upstream template.
|
|
- `\refname` is redefined twice (once in the `.cls`, once inline in the `.tex` Publications section) — the inline redefinition is a documented workaround the upstream author couldn't get working from the `.cls` alone.
|
|
- The first bullet of column two has a hand-tuned `\vspace{\topsep}` to fix awkward spacing — don't remove it without checking the rendered output.
|
|
|
|
## Upstream
|
|
|
|
Forked from https://github.com/deedydas/Deedy-Resume (Apache 2.0). The README in this repo is the upstream README and still references the upstream author's content; treat it as template documentation rather than a description of this fork.
|