diff --git a/README.md b/README.md index a408012..f74703c 100644 --- a/README.md +++ b/README.md @@ -4,46 +4,56 @@ Awesome CV This is the class for writing CV(Curriculum Vitae) in LaTeX. It basically provides an awesome template for CV. It is also fairly customizable, allowing you to change the colors, the fonts, etc. -## Prerequisites +## How to Use +### Requirements -### Ubuntu(Debian) +You have to install fundamental latex packages on system including xelatex. Also, Awesome-CV uses [Font Awesome](http://fortawesome.github.io/Font-Awesome/) to draw icons. You have to install on system. + +#### Ubuntu(Debian) ```bash -$ sudo apt-get install texlive texlive-latex-extra +$ sudo apt-get install texlive texlive-latex-extra texlive-xetex ``` ```bash $ sudo apt-get install fonts-font-awesome ``` -## How to use +#### Install Source Sans Pro Font +```bash +$ sudo wget https://github.com/adobe-fonts/source-sans-pro/archive/2.010R-ro/1.065R-it.tar.gz +$ tar -xvf 1.065R-it.tar.gz +$ mkdir -p ~/.fonts +$ cp source-sans-pro-2.010R-ro-1.065R-it/OTF/*.otf ~/.fonts/ +$ fc-cache -f -v +``` + +### Usage In Linux run ```bash -$ xelatex {filename}.tex +$ xelatex {your-cv}.tex ``` -This should result in the creation of ``{filename}.pdf`` +This should result in the creation of ``{your-cv}.pdf`` ## Preview ![alt tag](https://raw.githubusercontent.com/posquit0/resume/master/sample.png) ## 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-FontAwesome -https://github.com/furl/latex-fontawesome +[Latex FontAwesome](https://github.com/furl/latex-fontawesome) is bindings for FontAwesome icons to be used in XeLaTeX. -## Contribution -Contact me - -## Note -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! - -Good luck! +### 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. ## 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!