cv

Adrian Ng – Curriculum Vitae

This repository contains my personal CV, which is automatically built and published as a PDF using GitHub Actions.
You can fork, clone, and customize it for your own use—with no need to install dependencies locally!

---

🚀 Quick Start

1. Fork the repository:
   Click the “Fork” button at the top-right of this page to create a copy under your GitHub account.

2. Clone your forked repository:
   Replace <YOUR-USERNAME> with your GitHub username:

   git clone https://github.com/<YOUR-USERNAME>/cv.git
   cd cv
   

3. Make your changes:
   Edit the LaTeX or other source files (e.g. cv.tex, page1sidebar.tex, etc.) as needed.

4. Push your changes:

   git add .
   git commit -m "Update CV"
   git push
   

5. Automatic PDF Generation:
   After you push, GitHub Actions will automatically build and generate a new PDF of your CV. Check the Actions tab for build status.

🧹 Pre-commit Framework Setup

This repository uses pre-commit to automate code quality checks before each commit. Follow these steps to set it up:

1. Install pre-commit

If you have Python installed, run:

pip install pre-commit

2. Set up pre-commit hooks

Run the following command in the repository root:

pre-commit install

This will install the hooks so they run automatically on git commit.

3. Run pre-commit manually (optional)

To check all files at any time, run:

pre-commit run --all-files

4. Customizing Hooks

Edit the .pre-commit-config.yaml file to add or modify hooks as needed. See pre-commit documentation for available hooks.

---

📦 Releases & PDF Generation

When you publish a new release on this repository, a GitHub Action will:

• Build the CV PDF from the exact commit of the release.
• Upload the generated cv.pdf as a release asset.

You can always download the latest or any previous version of the CV from the Releases page.

Download Latest CV (cv.pdf)

---

📂 Repository Structure

• cv.tex, altacv.cls – Main LaTeX CV files
• page1sidebar.tex, page2sidebar.tex – Sectioned content for the CV
• requirements.txt – (If you want to build locally, see requirements)
• .github/workflows/ – GitHub Actions workflow files for automated builds
• tex/ – (If present) Additional LaTeX resources

---

🛠️ Customization

• Fork or clone the repository.
• Replace content in the LaTeX source files with your own information.
• Push changes to trigger the automated PDF build and release process.

---

🤝 Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

---

📄 License

This project is licensed under the MIT License.

---

📬 Contact

Find me on GitHub or via LinkedIn.