1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
My Resume and LaTeX Template
============================
Introduction
------------
This repository holds my [resume](resume-zh+en.pdf) (Chinese and English),
the [resume LaTeX template](resume.cls),
and the [Font Awesome 5 LaTeX style](fontawesome5/fontawesome5.sty).
This template is based on the
[YACC: Another Awesome CV](https://github.com/darwiin/yaac-another-awesome-cv)
by Christophe Roger, which is further based on the
[Plasmati Graduate CV](https://www.latextemplates.com/template/plasmati-graduate-cv)
by Alessandro Plasmati.
Usage
-----
* Linux
1. Install XeLaTeX, latexmk, GNU Make, and GhostScript packages;
2. Install [Font Awesome 5](#font-awesome-5) and
other [required fonts](#required-fonts);
3. Replace `resume-zh.tex` and `resume-en.tex` with your versions;
4. Compile to PDFs with a simple `make` :-)
* Windows
1. Install [MiKTeX](https://miktex.org/);
2. Install [Font Awesome 5](#font-awesome-5) and
other [required fonts](#required-fonts);
3. Copy `fontawesome5/fontawesome5.sty` to the current directory
(i.e., the same directory as `resume.cls` and `resume-*.tex`)
so that it can be auto found;
4. Replace `resume-zh.tex` and `resume-en.tex` with your versions;
5. Open `resume-*.tex` in TeXWorks, choose `XeLaTeX` to compile,
and confirm the prompts to install the missing packages along
the run.
Font Awesome 5
--------------
**NOTE**:
The [fontawesome5 package](https://www.ctan.org/pkg/fontawesome5) from CTAN
is used, which is more advanced and bundles with the font files.
The original [fontawesome5](fontawesome5/) contents are now obsolete but kept
for reference.
<blockquote>
I wrote a simple tool [`make-fontawesome5.py`](fontawesome5/make-fontawesome5.py),
which will download the latest icon list from the
[Font Awesome](https://github.com/FortAwesome/Font-Awesome) project
and then generate the LaTeX style file for using the latest
**Font Awesome 5** fonts (the *free* edition) in LaTeX.
This Python script requires the [`PyYAML`](https://github.com/yaml/pyyaml)
package, which can be installed with `pip3 install --user PyYAML`
or `sudo apt install python3-yaml`.
A pre-generated style file [`fontawesome5.sty`](fontawesome5/fontawesome5.sty)
(matches Font Awesome **v5.15.4**) is also provided.
The Font Awesome fonts are designed by the
[Font Awesome project](https://fontawesome.com/)
and can be obtained from [here](https://fontawesome.com/v5/download).
**NOTE**:
All the following 3 fonts should be installed into the system:
* Font Awesome 5 Free
(generic icons in regular style, much less than the solid style)
* Font Awesome 5 Free Solid
(generic icons in solid style)
* Font Awesome 5 Free Brands
(various brand icons)
i.e., the following 3 OTF files are needed:
* `Font Awesome 5 Free-Regular-400.otf`
* `Font Awesome 5 Free-Solid-900.otf`
* `Font Awesome 5 Brands-Regular-400.otf`
</blockquote>
Required Fonts
--------------
Besides the Font Awesome fonts, this template also requires the following
opensource fonts:
* [IBM Plex](https://github.com/IBM/plex) (Serif, Mono)
Download the `OpenType.zip` archive from the
[releases](https://github.com/IBM/plex/releases) page,
and then extract the `IBM-Plex-Serif` and `IBM-Plex-Mono` directories
and install them.
* [Source Han Serif](https://github.com/adobe-fonts/source-han-serif)
Download the `SourceHanSerifSC.zip` archive
(Language Specific OTFs Simplified Chinese) from the
[releases](https://github.com/adobe-fonts/source-han-serif/releases) page,
and then install all of them.
Of course, you can use the fonts you prefer by modifying the template directly.
However, you may need to tweak the
[column width in the template](resume.cls#L158)
accordingly.
Fonts Installation
------------------
On **Linux** systems, create a directory for each font family under
`~/.local/share/fonts`, then copy the font files (OTF or TTF) over,
then execute `fc-cache -f` to refresh the font cache, done.
Take the *Font Awesome* font family as an example:
1. `mkdir -p ~/.local/share/fonts/FontAwesome`
2. `cp <font-awesome-otf-files> ~/.local/share/fonts/FontAwesome/`
3. `fc-cache -fv`
4. check the fonts correctly installed: `fc-list | grep 'FontAwesome'`
License
-------
* The LaTeX class [`resume.cls`](resume.cls) is distributed under the
[LaTeX Project Public License (LPPL) Version 1.3c](https://www.latex-project.org/lppl.txt).
* The tool [`make-fontawesome5.py`](fontawesome5/make-fontawesome5.py)
is distributed under the
[MIT License](https://opensource.org/licenses/MIT).
* All content files are published under the
[CC BY 4.0 License](https://creativecommons.org/licenses/by/4.0/).
|
