README
¶
📄 Resume Generator
Generate professional resumes and cover letters with the power of Go and LaTeX. Separate your content from styling, and focus on what matters most—showcasing your experience.
Yes, I know I'm spending more time on this than I'll save. That's half the fun!
✨ Features
- Content-Style Separation: Write your resume content in YAML, let LaTeX handle the formatting
- Live Preview: Watch your changes render in near real-time as you edit
- Multiple Output Support: Generate both resumes and cover letters from a single source
- Base Resume Templates: Use a base resume for common information, customize for specific applications
- Interactive Setup: User-friendly configuration process to get you started quickly
📋 Example Output
This is a sample resume generated using the default template. Your resume can look different based on your chosen template and content.
🚀 Quick Start
Prerequisites
- Go 1.21 or higher
- LaTeX distribution with
pdflatex
Installation
# Clone the repository
git clone https://github.com/munirmah/Resume-Generator.git
# Navigate to project directory
cd Resume-Generator
# Install dependencies
go get .
# Build the project
go build .
Basic Usage
# Generate a resume with default settings
./Resume-Generator -f your-resume.yml
# Enable live preview while editing
./Resume-Generator -f your-resume.yml -r
# Generate both resume and cover letter
./Resume-Generator -f your-resume.yml -c
🎯 Core Concepts
YAML-Based Content
Your resume content lives in a clean, human-readable YAML file:
information:
name: "Jane Doe"
email: "jane@example.com"
phone: "123-456-7890"
experience:
- company: "Tech Corp"
title: "Senior Developer"
start_date: "2020-01-01"
end_date: "Present"
description:
- "Led development of core platform features"
- "Mentored junior developers"
Section Ordering
Customize your resume's section order using simple letter codes:
e- Educationx- Experiences- Skillsp- Projectsc- Certificationst- Customm- Summary
Example: -o xsep renders Experience → Skills → Education → Projects
🛠️ Configuration
Command Line Flags
| Flag | Description | Default |
|---|---|---|
-f |
Resume YAML file | Required |
-b |
Base resume template | Optional |
-c |
Generate cover letter | false |
-r |
Enable live preview | false |
-o |
Section order | Required |
-s |
Show PDF after generation | false |
-l |
Log level (debug,info,warn,error) | error |
Configuration File
The tool uses a .config file for persistent settings. First run creates this interactively, or override with flags.
🔍 Advanced Features
Base Resume System
Use a base resume for unchanging information:
./Resume-Generator -b base.yml -f job-specific.yml
Live Preview Mode
Enable real-time PDF updates while editing:
./Resume-Generator -f resume.yml -r
🤝 Contributing
Contributions welcome! Feel free to:
- Open issues for bugs or suggestions
- Submit pull requests
- Improve documentation
- Share your templates
📝 License
This project is licensed under the MIT License - see the LICENSE file for details.
Made with ❤️ by munirmah
Documentation
¶
There is no documentation for this package.