From 2f655adf7627fc4dbb3a4b9b103c2d149a719f8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20K=C3=BCster?= Date: Tue, 15 Aug 2017 11:04:07 +0200 Subject: [PATCH 1/6] Update README.md --- README.md | 76 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 50 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 8504c9a..81eaffd 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,67 @@ +[![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) + # latexcv - LaTex CV and Resume Collection -## Summary - A collection of simple and easy to use, yet powerful LaTex templates for CV and resume. All of them are self designed and self implemented and not copied from template collections. -If there are any problems, please create an issue. I will fix it asap. Contributors are very welcome. +If there are any problems, please create an issue. I will fix it asap. **Contributors are very welcome**. -[See the preview / example outputs](https://github.com/jankapunkt/latexcv#gallery) +## Gallery + +This is a preview of the currently featured templates. There is also an example output pdf in each template's directory. + + + + + + + + + + + + + + +
ClassicModernInfographicsTwo Columns
+ Classic CV example preview + + Modern CV example preview + + Infographics CV example preview + + Two Column CV example preview +
## How to build? -You can build them from this source. In each folder is a main.tex, which needs to be compiled by your LaTex distribution. The main.pdf shows the example output. +##### Build Requirements -There are just few requirements: +The following packages need to be installed: - package tex-live distribution - package tex-live fonts -- (in miktex all requirements should be included at compile-time) -- run the main.tex and build with a (pdf-) LaTeX environment of your choice +- a LaTeX environment of your choice with pdfLatex capability + +##### Build Procedure + + - Clone or download this project. + - Each template is in a folder, which contains a main.tex file + - Edit the main.tex according to your 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 your. ## License @@ -42,21 +84,3 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -## Gallery - -### Classic - -![Modern cv preview image](http://jankuester.com/wp-content/uploads/main_preview.png "Modern CV example preview") - -### Modern - -![Modern cv preview image](http://jankuester.com/wp-content/uploads/main_preview-1.png "Modern CV example preview") - -### Infographics - -![Infographics preview image](http://jankuester.com/wp-content/uploads/infographics-cv.png "Infographics CV example preview") - -### Two Column - -![Two Column preview image](http://jankuester.com/wp-content/uploads/twocolumn-cv.png "Infographics CV example preview") From 0f555358850dc471c653eb619d3d29d9ead1d485 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20K=C3=BCster?= Date: Mon, 18 Dec 2017 22:41:19 +0100 Subject: [PATCH 2/6] Create LICENSE --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a8b21ad --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 Jan Küster + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From e7b1461c4e1232d6d45227649866ffcb012a1df2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20K=C3=BCster?= Date: Mon, 18 Dec 2017 22:55:15 +0100 Subject: [PATCH 3/6] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 81eaffd..a402532 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ [![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) + # latexcv - LaTex CV and Resume Collection A collection of simple and easy to use, yet powerful LaTex templates for CV and resume. All of them are self designed and self implemented and not copied from template collections. From 488e1edcc0155c07c3ae46cee4132bb6536fc7ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20K=C3=BCster?= Date: Mon, 18 Dec 2017 23:31:58 +0100 Subject: [PATCH 4/6] Create CONTRIBUTING.md --- CONTRIBUTING.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2af2d10 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Contributing + +Everyone is welcome to open a pull request and improve this package. To maximize the chance to make the PR become accepted, please consider the following guidelines. + +### Structure + +* Each template should have in its own directory +* A template should always consist of a `main.tex` file and should only be extended, if the code extends the complexity of a single file (e.g. more than 1000 lines). +* Included `.tex` files should be stored in a folder, e.g. named "lib" (for structural docs) or "g" (for tikz graphics). +* Non-compiling PRs will be rejected +* Always add the main.pdf output as a +* No interdependencies between templates, please. I know this creates a lot of duplicate code, but there is a clear intention behind this: Users and especially those who are new to LaTeX should have a quick editable, easy to understand and easy to compile template to create their own cv. Therefore each cv should be viewed as a single instance. In the future there may be an enhancement to define the personal credentials in a single file and include it in each cv template. +* Make sure, that your PR does not cause a template to exceed the size of one page. This project intends to keep every tamplte short and clear. + +### Code + +* Comments should be added as often as possible. Please see the modern or infographics template for orientation. +* Greater sections should be introduced with a block-sized comment. Please see the modern or infographics template for orientation. +* Please comment parameters. If a parameter is not commented yet and the command is therefore not understandable, please open an issue. + + +### Learn LaTeX + +The following constructs/libraries are crucial to know in order to conribute successfully: + +* newenvironment +* newcommand +* tikz + + +A good way to start are the following pages: + +Wikibooks: https://en.wikibooks.org/wiki/LaTeX +For Questions: https://tex.stackexchange.com/ +Especially Tikz: http://www.texample.net/tikz/ From 008231e352e4fa906b3e12ea3ea4b2900ad36e1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20K=C3=BCster?= Date: Mon, 18 Dec 2017 23:37:15 +0100 Subject: [PATCH 5/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2af2d10..a28db1d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,9 +9,17 @@ Everyone is welcome to open a pull request and improve this package. To maximize * Included `.tex` files should be stored in a folder, e.g. named "lib" (for structural docs) or "g" (for tikz graphics). * Non-compiling PRs will be rejected * Always add the main.pdf output as a -* No interdependencies between templates, please. I know this creates a lot of duplicate code, but there is a clear intention behind this: Users and especially those who are new to LaTeX should have a quick editable, easy to understand and easy to compile template to create their own cv. Therefore each cv should be viewed as a single instance. In the future there may be an enhancement to define the personal credentials in a single file and include it in each cv template. * Make sure, that your PR does not cause a template to exceed the size of one page. This project intends to keep every tamplte short and clear. +### Dependencies + +* There are currently only `tex-live` and `tex-live fonts` as dependencies and most of even complex operations can be implemented (see inforgraphics template). Therefore creating a new package dependecy may defy the goal of being simple to install and compile. +* Solutions using Xetex and Luatax as well as Komascript and others will therefore not be included +* No interdependencies between templates, please. + +I know this creates lots of duplicate code or make it harde to solve a feature request, but there is a clear intention behind this: Users and especially those who are new to LaTeX should have a quick editable, easy to understand and easy to compile template to create their own cv. Therefore each cv should be viewed as a single instance. In the future there may be an enhancement to define the personal credentials in a single file and include it in each cv template. + + ### Code * Comments should be added as often as possible. Please see the modern or infographics template for orientation. From 735c864d0eca74e5f616bd5fcbd0e9c63a819073 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20K=C3=BCster?= Date: Mon, 18 Dec 2017 23:39:10 +0100 Subject: [PATCH 6/6] README - linked contribution guidelines --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index a402532..26810ac 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,11 @@ The following packages need to be installed: Create an issue, if this manual does not work for your. +##### 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. + + ## License The MIT License (MIT)