README.md 10.5 KB
Newer Older
Christophe Roger's avatar
v1.8.0    
Christophe Roger committed
1
YAAC: Another Awesome CV [![CircleCI](https://circleci.com/gh/darwiin/yaac-another-awesome-cv.svg?style=svg)](https://circleci.com/gh/darwiin/yaac-another-awesome-cv) [![Example](https://img.shields.io/badge/Exemple-pdf-blue.svg)](https://github.com/darwiin/yaac-another-awesome-cv/releases/download/v1.8.0/cv.pdf)
darwiin's avatar
darwiin committed
2
3
=================

Christophe Roger's avatar
Christophe Roger committed
4
## Quick start
5

Christophe Roger's avatar
Christophe Roger committed
6
You can edit online **YAAC: Another Awesome CV** template on [Overleaf](https://www.overleaf.com/latex/templates/awesome-source-cv/wrdjtkkytqcw). Feel free to use my [referal link](https://www.overleaf.com/signup?ref=54c221604cd6) if you want to create your account.
7

Christophe Roger's avatar
Christophe Roger committed
8
## About
Christophe Roger's avatar
Christophe Roger committed
9

10
**YAAC: Another Awesome CV** was first based on a CV template from Alessandro Plasmati. This template used _XeLaTeX_ engine and _[Fontin Sans](http://www.exljbris.com/fontinsans.html)_ font. 
Christophe Roger's avatar
Christophe Roger committed
11

12
**Personal data** has moved on top of the first page just before the position and _[Fontin Sans](http://www.exljbris.com/fontinsans.html)_ font has been replaced by _[Source Sans Pro Font](https://github.com/adobe-fonts/source-sans-pro)_ from Adobe. _[Font Awesome](http://fontawesome.io/)_ icons highlight important elements.
Christophe Roger's avatar
Christophe Roger committed
13

Christophe Roger's avatar
Christophe Roger committed
14
Unlike _Alessandro Plasmati_ CV template, all layout stuff in **YAAC: Another Awesome CV** has moved in the Latex class file _yaac-another-awesome-cv.cls_ to improve source code readability and style reusability.
15

Christophe Roger's avatar
Christophe Roger committed
16
More informations about the original Alessandro Plasmati template can be found here :
Christophe Roger's avatar
Christophe Roger committed
17

Christophe Roger's avatar
Christophe Roger committed
18
19
20
   -  [ Scribd ](http://fr.scribd.com/doc/16335667/Writing-your-Professional-CV-with-LaTeX)
   -  [ LaTeX Templates ](http://www.latextemplates.com/template/plasmati-graduate-cv)
   -  [ ShareLatex ](https://www.sharelatex.com/templates/cv-or-resume/professional-cv)
Christophe Roger's avatar
Christophe Roger committed
21

Christophe ROGER's avatar
Christophe ROGER committed
22
## Preview
Christophe ROGER's avatar
v1.9.2    
Christophe ROGER committed
23
24
25

### Normal style

Christophe ROGER's avatar
Christophe ROGER committed
26
27
| Page. 1 | Page. 2 |
|:---:|:---:|
Christophe ROGER's avatar
Christophe ROGER committed
28
| ![Résumé](example/preview/cv1.jpeg) | ![Résumé](example/preview/cv2.jpeg) |
Christophe ROGER's avatar
Christophe ROGER committed
29

Christophe ROGER's avatar
v1.9.2    
Christophe ROGER committed
30
31
32
33
34
35
### Alternative style

| Page. 1 | Page. 2 |
|:---:|:---:|
| ![Résumé](example/preview/cv1-alternative.jpeg) | ![Résumé](example/preview/cv2-alternative.jpeg) |

Christophe Roger's avatar
Christophe Roger committed
36
## How to use **YAAC: Another Awesome CV** latex class
Christophe Roger's avatar
Christophe Roger committed
37

Christophe Roger's avatar
Christophe Roger committed
38
### Use the **YAAC: Another Awesome CV** options
39

40
When declaring the `\documentclass` you can use option(s) to customize your CV rendering.
41
42
43
44
45
1. **localFont** to use the fonts included in the _fonts_ folder
2. **alternative** to use the _alternative header_ layout
3. **10pt** or **11pt** or **12pt** to change the font size
4. **compact** to reduce vertical space between you experience entries

46
47
48

```latex
% Used with no option, the template will use the 'traditional' 
49
% header layout your system fonts and the default color scheme ie. blue
Christophe Roger's avatar
Christophe Roger committed
50
\documentclass{yaac-another-awesome-cv}
51
52

% Used with localFont option the template will use the 'traditional' 
53
% header layout, fonts included in the fonts directory and the default color scheme
Christophe Roger's avatar
Christophe Roger committed
54
\documentclass[localFont]{yaac-another-awesome-cv}
55

Christophe ROGER's avatar
Christophe ROGER committed
56
% Used with alternative option, the template will use the 'alternative' 
57
% header layout, your system fonts and the default color scheme
Christophe Roger's avatar
Christophe Roger committed
58
\documentclass[alternative]{yaac-another-awesome-cv}
59

Christophe ROGER's avatar
Christophe ROGER committed
60
61
62
63
64
% Used with localFont, alternative and 10pt options the template will use the 'alternative' 
% header layout, fonts included in the fonts directory, the default color scheme and the '10pt' font size.
% Based on the article document class, size options are 10pt, 11pt and 12pt
\documentclass[localFont,alternative,10pt]{yaac-another-awesome-cv}

65
66
67
68
% Used with 'compact' option the template will use the compact experience layout 
% Feel free to use this option with the others that are available
\documentclass[compact]{yaac-another-awesome-cv}

69
70
```

Christophe Roger's avatar
Christophe Roger committed
71
72
### Construct the header

Christophe Roger's avatar
Christophe Roger committed
73
Outside of the `\socialinfo` wrapper you have to define the mandatory parameters `\name` and `\tagline`.
Christophe Roger's avatar
Christophe Roger committed
74

75
```latex
Christophe Roger's avatar
Christophe Roger committed
76
77
78
79
80
% Define author's name
% Usage: \name{<firstname>}{<lastname>}
% Mandatory
\name{Christophe}{ROGER}

Christophe Roger's avatar
Christophe Roger committed
81
% Define author's photo (optional)
82
% Usage: \photo[<shape: circular, square, roundedsquare, squircle>]{<diameter>}{<photo>}
83
% The shape of the author's photo is circular by default.
Christophe Roger's avatar
Christophe Roger committed
84
85
\photo{2.5cm}{darwiin}

Christophe Roger's avatar
Christophe Roger committed
86
87
88
89
% Define author's tagline
% Usage: \tagline{<tag line>} 
% Mandatory
\tagline{Chef de projet IT}
Christophe Roger's avatar
Christophe Roger committed
90
```
Christophe Roger's avatar
Christophe Roger committed
91

Christophe Roger's avatar
Christophe Roger committed
92
Most social network have their command to render a clickable link or a simple text entry.
Christophe Roger's avatar
Christophe Roger committed
93

Christophe Roger's avatar
Christophe Roger committed
94
95
96
97
98
99
100
101
102
103
104
105
106
```latex
% Render author's linked-in (optional)
% Usage: \linkedin{<linked-in-nick>}
\linkedin{christopheroger}

% Render author's viadeo(optional)
% Usage: \viadeo{<viadeo-nick>}
\viadeo{christopheroger}

% Render author's github (optional)
% Usage: \github{<github-nick>}
\github{darwiin}

107
108
109
110
111
112
113
114
% Render author's stackoverflow profile (optional)
% Usage: \stackoverflow{<stackoverflow-user-id>}
\stackoverflow{759643}

% Render author's stackexchange profile (optional)
% Usage: \stackexchange{<stackexchange-user-id>}
\stackexchange{396216}

Christophe Roger's avatar
Christophe Roger committed
115
116
117
118
119
% Render author's email (optional)
% Usage: \email{<email adress>}
\email{christophe.roger@mail.com}
```

Christophe Roger's avatar
Christophe Roger committed
120
Put these command in the `\socialinfo` wrapper. Feel free to add `\\` when you want to force a new line.
Christophe Roger's avatar
Christophe Roger committed
121

Christophe Roger's avatar
Christophe Roger committed
122
```latex
Christophe Roger's avatar
Christophe Roger committed
123
124
125
126
\socialinfo{
  \linkedin{christopheroger}
  \viadeo{christopheroger}
  \github{darwiin}\\
Christophe Roger's avatar
Christophe Roger committed
127
128
129
  \smartphone{+687 123 456}
  \email{christophe.roger@mail.com}\\
  \address{2 Rue du quartier, 98765 Ville, Pays}\\
Christophe Roger's avatar
Christophe Roger committed
130
  \infos{Né le 23 septembre 1982 (35 ans) à Nouméa, Nouvelle-Calédonie}
Christophe Roger's avatar
Christophe Roger committed
131
}
Christophe Roger's avatar
Christophe Roger committed
132
```
133

Christophe Roger's avatar
Christophe Roger committed
134
Use the `\makecvheader`command to generate the header.
Christophe Roger's avatar
Christophe Roger committed
135
136
137
138
139

```latex
\makecvheader
```

Christophe ROGER's avatar
v2.2.0    
Christophe ROGER committed
140
141
142
143
144
145
146
147
148
### Set the left column size

Sections share the left column size (2.5cm by default). You can change this default size using the `\setleftcolumnlength` command.

```latex
% Override default left column length of (2.5cm) (optional)
% Usage: \setleftcolumnlength{1.5cm} to change the left column lengtyh to 1.5cm
% I recommend to use a size between 1.5cm to 2.5cm
\setleftcolumnlength{1.5cm}
149
```
Christophe ROGER's avatar
v2.2.0    
Christophe ROGER committed
150
151


Christophe Roger's avatar
v1.8.0    
Christophe Roger committed
152
153
154
155
156
157
158
159
160
161
162
163
164
### Construct the _comptences_ or _skills_ section

To list your awesome skills as keyword lists you first have to declare the `keywords` environment and then fill it with a list of keywordsentry

```latex
% Begin a new keywords environment to show us your awesome keywords
  \begin{keywords}
    
    % Here's go your keyword lists group by categories
    \keywordsentry{Frameworks}{Spring, Spring Boot, \textbf{Ionic 3}, Angular 2, Angular 4, ZK, JBoss RichFaces}
  \end{keywords}
```

Christophe Roger's avatar
Christophe Roger committed
165
166
167
### Construct the _experiences_ section

To describe your experiences you have first to declare the `experiences` environment
Christophe Roger's avatar
Christophe Roger committed
168
169
170
171
172
173
174
175
176

```latex
% Begin a new experiences environment to use experience and consultantexperience macro
\begin{experiences}

% Here's go your experiences

\end{experiences}
```
Christophe Roger's avatar
Christophe Roger committed
177

Christophe Roger's avatar
Christophe Roger committed
178
Then you can describe your experiences using **\experience** and **\consultantexperience** entries. Each
Christophe Roger's avatar
Christophe Roger committed
179
entry must be separated by the **\emptyseparator** 
Christophe Roger's avatar
Christophe Roger committed
180

181
```latex
Christophe Roger's avatar
Christophe Roger committed
182
183
184
% Begin a new experiences environment to use experience and consultantexperience macro
\begin{experiences}

Christophe Roger's avatar
Christophe Roger committed
185
% The experience entry work as below and can be used to describe a job experience
186
187
188
189
190
191
192
193
194
195
196
197
  \experience
    {End date}      {Experience title}{Enterprise}{Country}
    {Begin date}    {
    				  experience details
                      \begin{itemize}
                        \item Item 1: _Item 1 description_
                        \item Item 2: _Item 2 description_
                        \item Item 3: _Item 3 description_
                      \end{itemize}
                    }
                    {Technology highlights}

Christophe Roger's avatar
Christophe Roger committed
198
199
200
% The emptyseparator macro is used to create white space in your experience
  \emptySeparator

Christophe Roger's avatar
Christophe Roger committed
201
202
% The consultantexperience macro is very similar to the experience macro, but offer you 
% the possibility tu put client details
Christophe Roger's avatar
Christophe Roger committed
203
204
205
  \consultantexperience
    {End date}        {Experience title}{Enterprise}{Country}
    {Begin date}      {Client job title}{Clent enterprise}
206
207
208
209
210
211
212
213
214
                    {
                      experience details
                      \begin{itemize}
                        \item Item 1: _Item 1 description_
                        \item Item 2: _Item 2 description_
                        \item Item 3: _Item 3 description_
                      \end{itemize}
                    }
                    {Technology highlights}
Christophe Roger's avatar
Christophe Roger committed
215
\end{experiences}
216
```
Christophe Roger's avatar
Christophe Roger committed
217

218
219
### Construct the _languages_ section

220
The _languages_ section use the **skills** environment. 
221
222
223
224
225
226

```latex
% Begin a new skills environment and fill it with skill entries
  \begin{skills}

% Render a skill in the skills environment
227
% Usage: \skill{<skill>}{<level between 1 and 5>}
228
229
230
231
232
233
234
    \skill{Français}{5}
    \skill{Anglais}{4}

% End the skills environment    
  \end{skills}
```

235
236
### Construct the _scolarship_ section

Christophe Roger's avatar
v1.8.0    
Christophe Roger committed
237
The _scolarship_ section use the **scolarship** environment.
238
239

```latex
Christophe ROGER's avatar
v1.9.2    
Christophe ROGER committed
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
\begin{scholarship}

  % Render a scholarshipentry in the scolarship environment
  % Usage: \scholarshipentry{<date>}{<description>}
  \scholarshipentry{2007}
    {Master STIC Professionel filière MBDS de l'Université de Nice Sophia Antipolis (Master Informatique spécialité Multimédia, Base de Données et intégration de Systèmes)}
  \scholarshipentry{2005}
    {Licence Sciences et Technologies, Mention Informatique, de l'Université de Nouvelle-Calédonie}
\end{scholarship}
```

### Construct the _projects_ section

The _projects_ section use the **projects** environment.

```latex
\begin{projects}
  \project
    {Simply City}{2017 - 2018}
    {\website{https://www.simplycity.nc}{https://www.simplycity.nc} \website{https://innovation.engie.com/fr/news/actus/territoires/simply-city-lappli-qui-simplifie-la-ville-au-ces-2018-avec-engie/8156}{Présentation CES 2018} }
    {Simply City est une application mobile, gratuite et participative destinée à tous les habitants, visiteurs et touristes qui séjournent dans une ville. L’application permet de connaître toutes les informations et services utiles en temps réel.}
    {Ionic 3,Typescript,Javascript,Visual Studio Code}
        
\end{projects}
264
```
265

Christophe Roger's avatar
v1.8.0    
Christophe Roger committed
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
### Construct the _references_ section

The _references_ section use the **references** environment.

```latex
  \begin{references}

    % Here's go your references

  \end{references}
```

Then you can list your references as follow:

```latex
  \begin{referees}
    \referee
      {John Snow}
      {Lord Commander of the Night Watch}
      {Night Watch}
      {john.snow@nightwatch.org}
      {+687 987 654}

    \referee
      {Géry Loutre}
      {Architecte logiciel}
      {Cafat}
      {ref1@cafat.nc}
      {+687 987 654}

  \begin{referees}
```


Christophe Roger's avatar
Christophe Roger committed
300
301
## License

Christophe Roger's avatar
Christophe Roger committed
302
Latex class file _yaac-another-awesome-cv_ is published under the term of the [LPPL Version 1.3c](https://www.latex-project.org/lppl.txt).
Christophe Roger's avatar
Christophe Roger committed
303

Christophe ROGER's avatar
Christophe ROGER committed
304
All content files are published under the term of the [CC BY-SA 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/legalcode).