Awesome-CV/README.md

92 lines
3.9 KiB
Markdown
Raw Normal View History

2015-12-10 10:21:44 +00:00
# Awesome CV [![Example](https://img.shields.io/badge/example-pdf-green.svg)](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/resume.pdf)
2015-12-10 01:06:30 +00:00
2015-01-18 09:32:22 +00:00
2015-12-15 04:16:53 +00:00
[**Awesome CV**](https://github.com/posquit0/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.
2015-01-18 08:50:16 +00:00
2015-12-15 04:16:53 +00:00
## Table of contents
* [Preview](#preview)
* [Quick Start](#quick-start)
* [How to Use](#how-to-use)
* [Credit](#credit)
* [Contact](#contact)
## <a name="preview"></a>Preview
#### Résumé
2015-05-15 11:35:34 +00:00
You can see [PDF](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/resume.pdf)
2015-12-15 04:16:53 +00:00
![Résumé(Page 1)](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/resume-0.png)
![Résumé(Page 2)](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/resume-1.png)
#### Cover Letter
2015-05-15 11:33:51 +00:00
2015-12-14 06:59:20 +00:00
You can see [PDF](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/coverletter.pdf)
2015-12-15 04:16:53 +00:00
![Cover Letter(Traditional)](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/coverletter-0.png)
![Cover Letter(Awesome)](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/coverletter-1.png)
2015-05-15 11:33:51 +00:00
2015-11-25 10:29:57 +00:00
2015-12-15 04:16:53 +00:00
## <a name="quick-start">Quick Start
* [**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)
2015-11-25 10:29:57 +00:00
**_Note:_ Above services do not guarantee up-to-date source code of Awesome CV**
2015-12-15 04:16:53 +00:00
## <a name="how-to-use">How to Use
#### Requirements
2015-05-11 14:27:49 +00:00
2015-11-25 10:29:57 +00:00
A full TeX distribution is assumed. [Various distributions for different operating systems (Windows, Mac, \*nix) are available](http://tex.stackexchange.com/q/55437) but TeX Live is recommended.
2015-11-20 17:31:55 +00:00
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.)
2015-01-18 09:32:22 +00:00
2015-12-15 04:16:53 +00:00
#### Usage
2015-05-11 14:27:49 +00:00
2015-11-20 17:31:55 +00:00
At a command prompt, run
2015-12-15 04:16:53 +00:00
2015-05-11 14:27:49 +00:00
```bash
2015-05-15 11:16:59 +00:00
$ xelatex {your-cv}.tex
2015-05-11 14:27:49 +00:00
```
2015-12-15 04:16:53 +00:00
2015-05-15 11:16:59 +00:00
This should result in the creation of ``{your-cv}.pdf``
2015-05-11 14:27:49 +00:00
##### List of Publications
You can generate list of publication from [**BibTeX**](http://www.bibtex.org/) source files.
[**BibLaTeX**](https://www.ctan.org/pkg/biblatex) and [**biber**](https://www.ctan.org/pkg/biber) should be available.
To generate document with the list of publications, at a command prompt, run
```bash
$ xelatex {your-cv}.tex
$ biber {your-cv}
$ xelatex {your-cv}.tex
```
2015-05-11 14:27:49 +00:00
2015-12-15 04:16:53 +00:00
## <a name="credit">Credit
[**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.
2015-01-18 09:32:22 +00:00
2015-12-15 04:16:53 +00:00
[**LaTeX FontAwesome**](https://github.com/furl/latex-fontawesome) is bindings for FontAwesome icons to be used in XeLaTeX.
2015-01-18 09:32:22 +00:00
2015-12-15 04:16:53 +00:00
[**Roboto**](https://github.com/google/roboto) is the default font on Android and ChromeOS, and the recommended font for Googles visual language, Material Design.
2015-01-18 09:32:22 +00:00
2015-12-15 04:16:53 +00:00
[**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.
2015-11-07 09:07:19 +00:00
2015-01-18 09:32:22 +00:00
2015-12-15 04:16:53 +00:00
## <a name="contact">Contact
2015-05-15 11:33:51 +00:00
2015-11-20 17:31:55 +00:00
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!
2015-05-15 10:53:18 +00:00
2015-05-11 14:27:49 +00:00
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.
2015-05-15 11:16:59 +00:00
Good luck!