# Resume Generator with Pandoc

This is a simple system to generate a professionally-formatted PDF resume from a Markdown file with YAML frontmatter.

## Requirements

- pandoc 
- XeLaTeX
- fontawesome package for LaTeX

## Installation

On Arch Linux, you can install the required packages with:

```bash
sudo pacman -S pandoc texlive-most
```

For detailed installation instructions for various operating systems and troubleshooting common issues, please see the [Installation Guide](INSTALL.md).

## Usage

1. Edit your resume data in `resume.md`
2. Run the generation script:

```bash
./generate_resume.sh
```

This will create `resume.pdf` in the current directory.

## Troubleshooting

If you encounter errors when generating the PDF:

1. First, make sure you have all the required packages installed
2. If you see errors about missing format files, run `sudo fmtutil-sys --all`
3. For font-related issues, see the troubleshooting section in the [Installation Guide](INSTALL.md)

## Customization

- `resume-template.tex` contains the LaTeX template that defines the appearance
- The resume data is structured in the YAML frontmatter of `resume.md`

## Format of resume.md

The resume.md file uses YAML frontmatter with the following structure:

```yaml
---
title: CV
name: Your Name
location: Your Location
email: your.email@example.com
phone: +1 234 567 8901
links:
  - url: https://example.com
    label: example.com
    icon: \faLink
  - url: https://github.com/yourusername
    label: yourusername
    icon: \faGithub
sections:
  - title: Education
    entries:
      - title: University Name
        subtitle: Degree
        right: 2019–2021
        bullets:
          - Detail 1
          - Detail 2
  - title: Experience
    entries:
      - title: Job Title
        subtitle: Company
        right: 2022–present
        bullets:
          - Responsibility 1
          - Achievement 2
---
```

## Credits

Based on Yuan's Resume template (MIT License)