improve README.md

This commit is contained in:
Posquit0.BJ 2015-12-15 13:16:53 +09:00
parent 01484a3037
commit d02551a455

View file

@ -1,60 +1,76 @@
# Awesome CV [![Example](https://img.shields.io/badge/example-pdf-green.svg)](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/resume.pdf) # Awesome CV [![Example](https://img.shields.io/badge/example-pdf-green.svg)](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/resume.pdf)
[**Awesome CV**](https://github.com/posquit0/Awesome-CV) is LaTeX template for a **CV(Curriculum Vitae)** or **resume** 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. [**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.
## Preview ## 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é
You can see [PDF](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/resume.pdf) You can see [PDF](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/resume.pdf)
![alt tag](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/resume-0.png) ![Résumé(Page 1)](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/resume-0.png)
![alt tag](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/resume-1.png) ![Résumé(Page 2)](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/resume-1.png)
#### Cover Letter
## Cover Letter
You can see [PDF](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/coverletter.pdf) You can see [PDF](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/coverletter.pdf)
![alt tag](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/coverletter-0.png) ![Cover Letter(Traditional)](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/coverletter-0.png)
![alt tag](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/coverletter-1.png) ![Cover Letter(Awesome)](https://raw.githubusercontent.com/posquit0/Awesome-CV/master/examples/coverletter-1.png)
## Quick Start
1. [**OverLeaf.com**](https://www.overleaf.com/latex/templates/awesome-cv/tvmzpvdjfqxp)(formerly **WriteLaTeX.com**) ## <a name="quick-start">Quick Start
2. [**ShareLaTeX.com**](https://www.sharelatex.com/templates/cv-or-resume/awesome-cv)
* [**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/cv-or-resume/awesome-cv)(**Not yet...**)
**_Note:_ Above services do not guarantee up-to-date source code of Awesome CV** **_Note:_ Above services do not guarantee up-to-date source code of Awesome CV**
## How to Use
### Requirements ## <a name="how-to-use">How to Use
#### Requirements
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. 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.
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.) 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 #### Usage
At a command prompt, run At a command prompt, run
```bash ```bash
$ xelatex {your-cv}.tex $ xelatex {your-cv}.tex
``` ```
This should result in the creation of ``{your-cv}.pdf`` This should result in the creation of ``{your-cv}.pdf``
## Credit ## <a name="credit">Credit
### LaTeX
LaTeX is a fantastic typesetting program that a lot of people use these days, especially the math and computer science people in academia.
You can find out more about it here: [LaTeX Project](http://www.latex-project.org) [**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 [**LaTeX FontAwesome**](https://github.com/furl/latex-fontawesome) is bindings for FontAwesome icons to be used in XeLaTeX.
[LaTeX FontAwesome](https://github.com/furl/latex-fontawesome) is bindings for FontAwesome icons to be used in XeLaTeX.
### Roboto [**Roboto**](https://github.com/google/roboto) is the default font on Android and ChromeOS, and the recommended font for Googles visual language, Material Design.
[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 [**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.
[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.
## Contact ## <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! 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. 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.