Merge branch 'master' into ci_setup
This commit is contained in:
jankapunkt
commit
ddadeddd7f
43
CONTRIBUTING.md
Normal file
43
CONTRIBUTING.md
Normal file
@ -0,0 +1,43 @@
|
||||
# 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
|
||||
* 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.
|
||||
* 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/
|
||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@ -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.
|
||||
82
README.md
82
README.md
@ -1,26 +1,74 @@
|
||||
[](https://travis-ci.org/jankapunkt/latexcv) [](http://www.repostatus.org/#active)
|
||||
|
||||
[](http://www.repostatus.org/#active)
|
||||
[](https://gitlicense.com/license/jankapunkt/latexcv)
|
||||
|
||||
# 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.
|
||||
|
||||
<table style="width:100%;">
|
||||
<tr>
|
||||
<th>Classic</th>
|
||||
<th>Modern</th>
|
||||
<th>Infographics</th>
|
||||
<th>Two Columns</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<img src="http://jankuester.com/wp-content/uploads/main_preview.png"
|
||||
alt="Classic CV example preview"
|
||||
height="280" />
|
||||
</td>
|
||||
<td>
|
||||
<img src="http://jankuester.com/wp-content/uploads/main_preview-1.png"
|
||||
alt="Modern CV example preview"
|
||||
height="280"/>
|
||||
</td>
|
||||
<td>
|
||||
<img src="http://jankuester.com/wp-content/uploads/infographics-cv.png"
|
||||
alt="Infographics CV example preview"
|
||||
height="280"/>
|
||||
</td>
|
||||
<td>
|
||||
<img src="http://jankuester.com/wp-content/uploads/twocolumn-cv.png"
|
||||
alt="Two Column CV example preview"
|
||||
height="280"/>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## 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.
|
||||
|
||||
##### 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
|
||||
|
||||
@ -43,21 +91,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
|
||||
|
||||
|
||||
|
||||
### Infographics
|
||||
|
||||
|
||||
|
||||
### Two Column
|
||||
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user