From f6a3e1983f981f0e53749ec70081420d0954e6c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20K=C3=BCster?= Date: Mon, 22 Oct 2018 21:17:05 +0200 Subject: [PATCH] Update README.md [ciskip] --- README.md | 52 +++++++++++++++++++++++++++++++++------------------- 1 file changed, 33 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 982d80f..5df8bdd 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,30 @@ -# latexcv - LaTex CV and Resume Collection +# latexcv - LaTex CV and Resume Collection [![Build Status](https://travis-ci.org/jankapunkt/latexcv.svg?branch=master)](https://travis-ci.org/jankapunkt/latexcv) [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) [![GitLicense](https://gitlicense.com/badge/jankapunkt/latexcv)](https://gitlicense.com/license/jankapunkt/latexcv) -A collection of simple and easy to use, yet powerful LaTex templates for CVs and resumes. All of them are self designed and self implemented and not copied from template collections. +A collection of simple and easy to use, yet powerful LaTeX templates for CVs and resumes. All of them are self designed and self implemented and not copied from template collections. -If there are any problems, please create an issue or - even better - a pull request. **Contributors are very welcome**. + +**Great first impression** + +Point out with a progressive layout. Give decision makers and HR only the most important information about you on one single page. + +**Beginner friendly** + +Pick a template, replace the content, compile, done. If tht's not enough you can easily customize colors, fonts and layout. The templates are documented directly in the code. + +**Minimal environment** + +You need a minimal tex-live distribution to compile the templates. No XeTeX or LuaTeX required. No other SDKs or environments required. ## Gallery This is a preview of the currently featured templates. There is also an example output pdf in each template's directory. - +
@@ -35,7 +46,7 @@ This is a preview of the currently featured templates. There is also an example alt="Infographics CV example preview" height="300"/> - +
Classic Modern
@@ -65,29 +76,32 @@ This is a preview of the currently featured templates. There is also an example ## How to build? -##### Build Requirements +The following guide just briefly describes the requirements and build procedure as there are many ways to install a LaTeX distrubution on various OS. Please create an issue, if this part is not helpful. -The following packages need to be installed: +**Build Requirements** -- package tex-live distribution -- package tex-live fonts -- package pdflatex +You will need some minimal Texlive distrubution (The full texlive distribution is nearly 2GB large but you will need only a part of it). A good starting point is here: https://www.latex-project.org/get/#tex-distributions -There is also a `texlive.profile` file in the project root, that can be used to install the minimum required texlive packages. +If you want to install texlive from tug.org instead, you can use this guide: https://tug.org/texlive/ -##### Build Procedure +Users of various Linux distrubutions can also install texlive from their repositories. - - Clone or download this project. - - For each template is in a folder, which contains a `main.tex` file do - - Edit the main.tex according to your credentials, optionally change settings and colors etc. - - Run `pdflatex` (build/compile) +This repo also contains a `texlive.profile` file in the project root, that can be used to install the minimum required texlive packages when manually installing texlive. + + +**Build Procedure** + + + * Clone or download this project. + * Change to a template folder, which contains a `main.tex` file do + * Edit the `main.tex` according to your CV credentials, optionally change settings and colors etc. + * Run `pdflatex` (build/compile) - The `main.pdf` should show the output. -Create an issue, if this manual does not work for you. -##### Contribution +## Contribution -Want to contribute? Awesome! Please check the [contribution guidelines](https://github.com/jankapunkt/latexcv/blob/master/CONTRIBUTING.md) first to make it a success. +**Contributors are very welcome**. You want to contribute? Awesome! Please check the [contribution guidelines](https://github.com/jankapunkt/latexcv/blob/master/CONTRIBUTING.md) first to make it a success. ## License