Quick Start

This guide takes a new Vectra copy from clone to compiled PDF.

Most users only need to edit profile and section files. Layout, typography, spacing, and the footer are already defined by the template.

1. Clone the Repository

Clone the official repository:

git clone https://github.com/yixnhuang/vectra.git
cd vectra

2. Install a LaTeX Distribution

You need a working LaTeX installation.

Recommended options:

TeX Live
MacTeX
MiKTeX
Overleaf

The default build uses latexmk with pdfLaTeX.

3. Edit Your Profile

Open:

cv/profile.tex

Update your personal information:

\VectraSetName{Your Name}
\VectraSetEmail{your.email@example.edu}
\VectraSetWebsite{https://your-website.example.com}
\VectraSetGitHub{https://github.com/your-username}

Optional fields include:

\VectraSetLinkedIn{}
\VectraSetORCID{}
\VectraSetPhone{}
\VectraSetLocation{}

You may also update PDF metadata:

\VectraSetPDFTitle{Your Name's CV}
\VectraSetPDFAuthor{Your Name}
\VectraSetPDFSubject{Curriculum Vitae}
\VectraSetPDFKeywords{Your Name, CV, academic CV}

4. Edit Document Settings

Open:

cv/settings.tex

The main setting most users may want to change is the date mode:

\VectraSetDateMode{today}

Available date modes:

today  - use the current compile date
fixed  - use a fixed update date
none   - hide the update date

For a fixed date:

\VectraSetDateMode{fixed}
\VectraSetFixedDate{January 2026}

Footer modes:

full   - left date, center name, right page number
simple - center name, right page number
none   - hide footer content

Default recommendation:

\VectraSetFooterMode{full}

5. Edit Your CV Sections

Edit files under:

cv/sections/

The personal CV structure includes:

education.tex
research-interests.tex
research-experience.tex
projects.tex
awards.tex
leadership-service.tex
skills.tex
certifications.tex

Add, remove, or revise entries inside these files.

Most entries follow this pattern:

\VectraEducationEntry
	{Institution}
	{Degree or Program}
	{Location}
	{Date}

or:

\VectraProjectEntry
	{Project Title}
	{Date}
	{Technologies or Role}
	{
		\item First achievement or contribution.
		\item Second achievement or contribution.
	}

6. Build the PDF

From the repository root, run:

make cv

The generated PDF will appear in:

output/

7. Build Examples

To build all examples:

make examples

To build everything:

make all

8. Clean Build Files

To remove LaTeX auxiliary files:

make clean

To remove generated PDFs from output/:

make clean-output

To remove both:

make distclean

9. What Not to Modify

Most users should not edit:

src/
cv/main.tex
Makefile
latexmkrc

The files in src/ define the template design and are part of the Vectra Template Source.

Most users only need to edit their personal content files. Advanced users may modify the template under the terms of the LPPL.

You may publish and share your generated CV or resume PDF.

You may distribute Vectra or a modified version in accordance with the LPPL. The simplest way to share the maintained version is to link to the official repository:

https://github.com/yixnhuang/vectra