Skip to content
Get packs

Guide · Open source

How to use resume: LaTeX résumé template guide

Updated · written with AI from the project's own documentation and checked against our catalogue data

billryan/resume is a free, MIT-licensed LaTeX template for writing a résumé or CV. You edit a plain-text TeX source with your details and compile it into a formatted PDF. This guide shows you how to get the template, where to add your information, and how to compile it with XeLaTeX, Overleaf or LaTeX.Online.

Résumébillryan/resume · ★ 11.5k · MIT

Quick start

  1. 1Install Git and a TeX option. Make sure you have Git and either a XeLaTeX-capable TeX distribution or an Overleaf account.
  2. 2Clone the master branch. Run the shallow single-branch git clone command into a folder of your choice.
  3. 3Edit your details. Open the TeX file and replace the sample content with your own information.
  4. 4Compile to PDF. Compile with XeLaTeX locally, or use Overleaf or LaTeX.Online.
  5. 5Check the output. Review the PDF and adjust the source until the layout and content are right.

Decide whether this template fits you

This template suits people who are comfortable with LaTeX and want a consistently styled, professional résumé they can keep as plain text under version control. You do not get a point-and-click builder: editing the LaTeX source is required.

  • Good fit: you want a plain-text source you can version-control, or you prefer compiling online instead of installing tools.
  • Good fit: you need a Simplified Chinese résumé, which lives on the zh_CN branch.
  • Poor fit: you want a drag-and-drop resume builder or do not want to work with LaTeX.

Get the template with git clone

Prerequisites are Git and either a XeLaTeX-capable TeX distribution or an Overleaf account. For an English résumé, the README recommends cloning only the master branch, using a shallow single-branch clone, because the Simplified Chinese font files are large.

  • Replace <folder> with the directory name you want to use.
  • If you want the Simplified Chinese version, use the zh_CN branch instead of master.
git clone https://github.com/billryan/resume.git --branch master --depth 1 --single-branch <folder>

Add your details to the template

The Quick Start in the README says to fork the repository and add information about yourself directly in GitHub. If you prefer to work locally, edit the TeX file in your cloned folder with your own content. The template is designed to be easy to customise and extend.

  • Keep the layout and replace the sample content with your own experience, education and skills.
  • Sample PDFs are linked in the README for English, English with a photo, and Simplified Chinese, so you can compare the output.

Compile the TeX file to PDF

The template is compiled with XeLaTeX, which supports Unicode text such as CJK characters. You have three options described in the README: compile locally with a XeLaTeX-capable TeX distribution, upload to Overleaf using the linked template, or compile with LaTeX.Online.

  • Overleaf: open the linked Overleaf template, edit online, and compile there.
  • LaTeX.Online: compile the TeX file with the LaTeX.Online service.
  • Local: compile the TeX file on your computer with XeLaTeX.

Fonts and Chinese output

The README says the template supports full Unicode, and that Simplified Chinese fonts work well when Adobe fonts are available. It also notes that those font files are large and depend on your OS setup. If you do not have Adobe Simplified Chinese fonts installed, the README suggests the English-only master branch unless you need Chinese output.

  • FontAwesome 4.6.3 is supported, according to the README.
  • Copyrighted fonts are not covered by the MIT License.

What people use it for

  • Keeping a résumé as a plain-text file in a Git repository and tracking changes over time.
  • Producing an English résumé with a consistent, professional style.
  • Creating a Simplified Chinese résumé from the zh_CN branch.
  • Writing and compiling a résumé in Overleaf without installing a TeX toolchain.

Frequently asked questions

Is billryan resume free to use?

Yes. The project is licensed under the MIT License. The README notes that copyrighted fonts are not covered by this licence.

What do I need to install to use it?

The README lists Git and a XeLaTeX-capable TeX distribution, or an Overleaf account. You can skip local installs by compiling online with Overleaf or LaTeX.Online.

Why does the template use XeLaTeX?

The template is compiled with XeLaTeX, which the README says gives full Unicode support, including CJK characters like Chinese.

How do I get the Simplified Chinese version?

Use the zh_CN branch, either on GitHub or by cloning that branch. The README points Chinese users to this branch.

Can I edit it without installing LaTeX?

Yes. The README links an Overleaf template for editing and compiling online, and LaTeX.Online is also mentioned for compiling the TeX file.

How does it compare to moderncv or awesome-cv?

This guide does not compare them in detail. The source lists moderncv, awesome-cv and simple-resume-cv as comparable projects, so review their own docs to decide which style and features suit you.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Choose billryan/resume if you are comfortable with LaTeX and want an elegant, consistently styled résumé that you can keep as plain text and compile in XeLaTeX or online. Pick a point-and-click builder instead if you do not want to edit source code, or if you need Simplified Chinese fonts and cannot set up the required Adobe fonts.

Install options & downloads