Awesome-CV/README.md
2017-05-05 11:59:18 -07:00

110 lines
5.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<h1 align="center">
<a href="https://github.com/posquit0/Awesome-CV" title="AwesomeCV Documentation">
<img alt="AwesomeCV" src="https://github.com/posquit0/Awesome-CV/raw/master/icon.png" width="200px" height="200px" />
</a>
<br />
Awesome CV
</h1>
<p align="center">
LaTeX template for your outstanding job application
</p>
<div align="center">
<a href="https://circleci.com/gh/posquit0/Awesome-CV">
<img alt="CircleCI" src="https://circleci.com/gh/posquit0/Awesome-CV.svg?style=shield" />
</a>
<a href="https://latexonline.cc/compile?git=https://github.com/posquit0/Awesome-CV&target=examples/resume.tex&command=xelatex">
<img alt="Example Resume" src="https://img.shields.io/badge/resume-pdf-green.svg" />
</a>
<a href="https://latexonline.cc/compile?git=https://github.com/posquit0/Awesome-CV&target=examples/cv.tex&command=xelatex">
<img alt="Example CV" src="https://img.shields.io/badge/cv-pdf-green.svg" />
</a>
<a href="https://latexonline.cc/compile?git=https://github.com/posquit0/Awesome-CV&target=examples/coverletter.tex&command=xelatex&workdir=.">
<img alt="Example Coverletter" src="https://img.shields.io/badge/coverletter-pdf-green.svg" />
</a>
</div>
<br />
## <a name="what-is-awesomecv"></a>What is Awesome CV?
**Awesome CV** is LaTeX template for a **CV(Curriculum Vitae)**, **Résumé** or **Cover Letter** inspired by [Fancy CV](https://www.sharelatex.com/templates/cv-or-resume/fancy-cv). It is easy to customize your own template, especially since it is really written by a clean, semantic markup.
## <a name="preview"></a>Preview
#### Résumé
You can see the latest version of [PDF here](https://latexonline.cc/compile?git=https://github.com/posquit0/Awesome-CV&target=examples/resume.tex&command=xelatex)
| Page. 1 | Page. 2 |
|:---:|:---:|
| [![Résumé](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/resume-0.png)](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/resume.pdf) | [![Résumé](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/resume-1.png)](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/resume.pdf) |
#### Cover Letter
You can see the latest version of [PDF here](https://latexonline.cc/compile?git=https://github.com/posquit0/Awesome-CV&target=examples/coverletter.tex&command=xelatex&workdir=.)
| Without Sections | With Sections |
|:---:|:---:|
| [![Cover Letter(Traditional)](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/coverletter-0.png)](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/coverletter.pdf) | [![Cover Letter(Awesome)](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/coverletter-1.png)](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/coverletter.pdf) |
## <a name="quick-start">Quick Start
1. Fork this repository
2. Edit files and commit changes
3. Use [LaTeX.Online](latexonline.cc) cloud compiler to create your PDF. Replace **LINK** with URL of your fork and open it:
- `https://latexonline.cc/compile?git=LINK&target=examples/cv.tex&command=xelatex`
- `https://latexonline.cc/compile?git=LINK&target=examples/resume.tex&command=xelatex`
- `https://latexonline.cc/compile?git=LINK&target=examples/coverletter.tex&command=xelatex&workdir=.`
Example: [https://latexonline.cc/compile?git=https://github.com/posquit0/Awesome-CV&target=examples/coverletter.tex&command=xelatex&workdir=.](https://latexonline.cc/compile?git=https://github.com/posquit0/Awesome-CV&target=examples/coverletter.tex&command=xelatex&workdir=.)
Other options:
* [**Edit Résumé on OverLeaf.com**](https://www.overleaf.com/latex/templates/awesome-cv/tvmzpvdjfqxp)
* [**Edit Résumé on ShareLaTeX.com**](https://www.sharelatex.com/templates/cv-or-resume/awesome-cv)
* [**Edit Cover Letter on OverLeaf.com**](https://www.overleaf.com/latex/templates/awesome-cv-cover-letter/pfzzjspkthbk)
* [**Edit Cover Letter on ShareLaTeX.com**](https://www.sharelatex.com/templates/cover-letters/awesome-cv-cover-letter)
**_Note:_ Above services do not guarantee up-to-date source code of Awesome CV**
## <a name="how-to-use">How to Use
#### Requirements
A full TeX distribution is assumed if you want to compile locally. [Various distributions for different operating systems (Windows, Mac, \*nix) are available](http://tex.stackexchange.com/q/55437) but TeX Live is recommended.
You can [install TeX from upstream](http://tex.stackexchange.com/q/1092) (recommended; most up-to-date) or use `sudo apt-get install texlive-full` if you really want that. (It's generally a few years behind.)
#### Usage
At a command prompt, run
```bash
$ xelatex {your-cv}.tex
```
This should result in the creation of ``{your-cv}.pdf``
## <a name="credit">Credits
[**LaTeX**](http://www.latex-project.org) is a fantastic typesetting program that a lot of people use these days, especially the math and computer science people in academia.
[**LaTeX FontAwesome**](https://github.com/furl/latex-fontawesome) is bindings for FontAwesome icons to be used in XeLaTeX.
[**Roboto**](https://github.com/google/roboto) is the default font on Android and ChromeOS, and the recommended font for Googles visual language, Material Design.
[**Source Sans Pro**](https://github.com/adobe-fonts/source-sans-pro) is a set of OpenType fonts that have been designed to work well in user interface (UI) environments.
## <a name="contact">Contact
You are free to take my `.tex` file and modify it to create your own resume. Please don't use my resume for anything else without my permission, though!
If you have any questions, feel free to join me at [`#posquit0` on Freenode](irc://irc.freenode.net/posquit0) and ask away. Click [here](https://kiwiirc.com/client/irc.freenode.net/posquit0) to connect.
Good luck!