docs(root): update README with new build instructions and variant information

This commit is contained in:
Prad Nukala
2026-06-25 14:35:00 -04:00
parent b656732886
commit 32b1a424f0
+27 -37
View File
@@ -1,57 +1,47 @@
CV — Prad Nukala # CV — Prad Nukala
=========================
<!--toc:start--> Multi-variant, single-page LaTeX résumé. Each variant targets a different role and lives as a standalone `.tex` file in `src/`; the raw career material lives as structured YAML in `docs/`.
- [CV — Prad Nukala
=========================](#cv-prad-nukala)
- [Build](#build)
- [Layout](#layout)
- [TODO](#todo)
- [License](#license)
<!--toc:end-->
Single-page LaTeX resume for **Prad Nukala** — Principal Architect, Distributed Systems & Applied Cryptography. Built on the [Deedy-Resume](https://github.com/deedydas/Deedy-Resume) OpenFonts template (XeLaTeX, two asymmetric columns). - Site: [prad.nu](https://prad.nu) · GitHub: [@prdlk](https://github.com/prdlk) · Email: [prad@sonr.io](mailto:prad@sonr.io)
- Site: [prad.nu](https://prad.nu) ## Variants
- Demo: [did.run](https://did.run)
- GitHub: [@prdlk](https://github.com/prdlk) | Variant | Role |
- Email: [prad@sonr.io](mailto:prad@sonr.io) |---------|------|
| `react-native` | Senior React Native Engineer |
| `protocol` | Senior Blockchain & Protocol Engineer |
| `cryptography` | Applied Cryptography & Security Engineer |
| `founding-engineer` | Founding Engineer & Full-Stack Builder |
## Build ## Build
Requires **XeLaTeX** and **BibTeX** (the template loads bundled OTFs in `fonts/lato/` and `fonts/raleway/` via `fontspec`, so all commands must run from the repo root). Requires **pdflatex** (`latexmk`) from any TeX Live / MacTeX install — no XeLaTeX, fonts, or BibTeX needed.
```bash ```bash
make # one-shot build → dist/deedy_resume-openfont.pdf make # build every variant → dist/*.pdf
make watch # latexmk -pvc: rebuild + live-preview on every save make protocol # build one variant by name
make preview # build once and open the PDF make preview V=protocol # build a variant and open it
make clean # remove LaTeX aux files, keep the PDF make watch V=protocol # rebuild + live-preview on save
make clean # remove LaTeX aux files, keep the PDFs
make distclean # remove dist/ entirely make distclean # remove dist/ entirely
``` ```
Under the hood, `make` runs `latexmk -xelatex -output-directory=dist`, which handles the BibTeX passes for `publications.bib` automatically. The Makefile globs `src/*.tex`, so dropping in `src/<role>.tex` gives you `make <role>` automatically.
## Layout ## Layout
- **`deedy_resume-openfont.tex`** — résumé content. Two `minipage` columns (`0.33\textwidth` left, `0.66\textwidth` right) split by `\hfill`. Each variant is a two-column [`paracol`](https://ctan.org/pkg/paracol) document (`\columnratio{0.3}`): a left rail (Contact, Skills, Honors, Organizations) and a main column (Experience, Projects, Education). The preamble and role-independent blocks are identical across variants — only the title, skills, experience bullets, and project ordering change.
- **`deedy-resume-openfont.cls`** — document class: colors, font mappings, and the custom commands (`\namesection`, `\runsubsection`, `\descript`, `\location`, `\sectionsep`, `tightemize`).
- **`publications.bib`** — entries cited via `\nocite{*}`.
- **`fonts/`** — bundled Lato + Raleway OTFs.
The template is **single-page by design** and silently overflows to a second page if either column gets too long. When adding content, prefer trimming over adding. Résumés are **single-page by design** and silently overflow if a column runs long. After editing, verify:
## TODO ```bash
pdfinfo dist/<variant>.pdf | grep Pages # must read: Pages: 1
```
- [ ] Add ./docs/projects/floadt.yml ## Source material
- [ ] Add ./docs/projects/likely.yml
- [ ] Add ./docs/experience/spacebolt.yml `docs/` holds the canonical career record as YAML (`experience/`, `projects/`, `skills/`, `recognition/`, `information/`). Variants are hand-curated from it — nothing auto-generates the `.tex`. See `AGENTS.md` files for per-directory detail.
- [ ] Add ./docs/projects/voluntree.yml
- [ ] Add ./docs/projects/yue.yml
- [ ] Add ./docs/experience/likely.yml
- [ ] Add ./docs/experience/pool.yml
- [ ] Add ./docs/experience/swiper-no-mauling.yml
- [ ] Add ./docs/experience/timeboard.yml
## License ## License
Template © 2014 Debarghya Das, Apache License 2.0. See [LICENSE](LICENSE). Apache License 2.0. See [LICENSE](LICENSE).