diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..cd60fe5 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,42 @@ +# 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..6b8d3be --- /dev/null +++ b/README.md @@ -0,0 +1,77 @@ +Deedy-Resume +========================= + +A **one-page**, **two asymmetric column** resume template in **XeTeX** that caters particularly to an **undergraduate Computer Science** student. +As of **v1.2**, there is an option to choose from two templates: + +1. **MacFonts** - uses fonts native to OSX - *Helvetica*, *Helvetica Neue* (and it's Light and Ultralight versions) and the CJK fonts *Heiti SC*, and *Heiti TC*. The EULA of these fonts prevents distribution on Open Source. +2. **OpenFonts** - uses free, open-source fonts that resemble the above - *Lato* (and its various variants) and *Raleway*. + +It is licensed under the Apache License 2.0. + +## Motivation + +Common LaTeX resume-builders such as [**moderncv**](http://www.latextemplates.com/template/moderncv-cv-and-cover-letter) and the [**friggeri-cv**](https://github.com/afriggeri/cv) look great if you're looking for a multi-page resume with numerous citations, but usually imperfect for making a thorough, single-page one. A lot of companies today search resumes based on [keywords](http://www.businessinsider.com/most-big-companies-have-a-tracking-system-that-scans-your-resume-for-keywords-2012-1) but at the same time require/prefer a one-page resume, especially for undergraduates. + +This template attempts to **look clean**, highlight **details**, be a **single page**, and allow useful **LaTeX templating**. + +## Preview + +### OpenFonts +![alt tag](https://raw.githubusercontent.com/deedydas/Deedy-Resume/master/OpenFonts/sample-image.png) + +### MacFonts +![alt tag](https://raw.githubusercontent.com/deedydas/Deedy-Resume/master/MacFonts/sample-image.png) + +## Dependencies + +1. Compiles only with **XeTeX** and required **BibTex** for compiling publications and the .bib filetype. +2. Uses fonts that are usually only available to **Mac** users such as Helvetica Neue Light. + +## Availability + +1. MacFonts version - [as an online preview](http://debarghyadas.com/resume/debarghya-das-resume.pdf) and [as a direct download](https://github.com/deedydas/Deedy-Resume/raw/master/MacFonts/deedy_resume.pdf) +2. OpenFonts version - [as a direct download](https://github.com/deedydas/Deedy-Resume/raw/master/OpenFonts/deedy_resume-openfont.pdf) +3. **Overleaf**.com (formerly **WriteLatex**.com) (v1 fonts/colors changed) - [compilable online](https://www.writelatex.com/templates/deedy-resume/sqdbztjjghvz#.U2H9Kq1dV18) +4. **ShareLatex**.com (v1 fonts changes) - [compilable online](https://www.sharelatex.com/templates/cv-or-resume/deedy-resume) + +## Changelog +### v1.2 + 1. Added publications in place of societies. + 2. Collapsed a portion of education. + 3. Fixed a bug with alignment of overflowing long last updated dates on the top right. + +### v1.1 + 1. Fixed several compilation bugs with \renewcommand + 2. Got Open-source fonts (Windows/Linux support) + 3. Added Last Updated + 4. Moved Title styling into .sty + 5. Commented .sty file. + +## TODO +1. Merge OpenFont and MacFonts as a single sty with options. +2. Figure out a smoother way for the document to flow onto the next page. +3. Add styling information for a "Projects/Hacks" section. +4. Add location/address information +5. Fix the hacky 'References' omission outside the .cls file in the MacFonts version. +6. Add various styling and section options and allow for multiple pages smoothly. + +## Known Issues: +1. Overflows onto second page if any column's contents are more than the vertical limit +2. Hacky space on the first bullet point on the second column. +3. Hacky redefinition of \refname to omit 'References' text for publications in the MacFonts version. + +## License + Copyright 2014 Debarghya Das + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License.