Skip to content

Commit a838c52

Browse files
authored
Improved explanation in README and CHANGELOG
1 parent cef0036 commit a838c52

File tree

2 files changed

+10
-13
lines changed

2 files changed

+10
-13
lines changed

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Changes in version 3
22
## Changes which affect regular users
3-
- Added a new `documentclass` option `colorharmony`, which defines a new color using color harmony models. The new color is called `second` and can use this color in the document with `\color{second}`. This color is also used for the new `link{}` command, see below.
4-
- Added a new `documentclass` option `titlecolor`, which allows you to set a separate color (compared to the header) of the titles.
3+
- Added a new `documentclass` option `colorharmony`, which defines a new color using color harmony models. The new color is called `second` and can be used in the document with `\color{second}`. This color is also used for the new `link{}` command, see below.
4+
- Added a new `documentclass` option `titlecolor`, which allows you to set a different color for the titles.
55
- Defined a new command `\FAspace` which replaces the old length `\FAspace` (and therefore breaks compatibility with the v2 class file). Now you can use `\FAspace` directly in the document, instead of using `\hspace{\FAspace}`.
6-
- Defined a new command `\link{someurl.com}`, which places a fontawesome logo in the document with the link. The color is detemined using the color harmony models.
6+
- Defined a new command `\link{someurl.com}`, which places a fontawesome logo in the document with the link. The color of the logo is detemined using the color harmony models.
77

88
# Changes in version 2
99
## Changes which affect regular users

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
1-
# CV Template for XeLaTeX
2-
I created a custom curriculum vitae class file (`.cls`), see the comments in `cv-roald-example.tex` to understand how it works.
3-
4-
This template lets you choose one base color via the `documentclass` option `changecolor`. By using a color harmony model, a color named `second` is chosen, which by default is only used for the links. However, by using the documentclass option `titlecolor=second`, it is also used for the titles. See the gif below for a little demo.
1+
# CV template for XeLaTeX
2+
![Example](cv-roald-example.png)
53

6-
By choosing colors using the color harmony models, you make sure the different colors in the document match nicely. See more information see the [wiki](https://en.wikipedia.org/wiki/Harmony_\(color\)) or [here](http://paletton.com/).
4+
This template lets you choose one base color via the `documentclass` option `changecolor`. You can for example use the color of the company you are applying for. By using a color harmony model, a color named `second` is picked. This color is only used for the links. However, if you choose the option `titlecolor=second`, the second color is also used for the titles. See the gif below for a little demo.
75

86
![demo](document_class_options_demo.gif)
97

10-
# Screenshot of cv-roald-example.pdf
11-
![Example](cv-roald-example.png)
8+
By choosing colors according to a color [harmony model](https://en.wikipedia.org/wiki/Harmony_\(color\)), you make sure the different colors match nicely. You can play around with different models [here](http://paletton.com/). For more information on how this template works, see the comments in `cv-roald-example.tex`.
129

1310
# Changes in version 3
1411
## Changes which affect regular users
15-
- Added a new `documentclass` option `colorharmony`, which defines a new color using color harmony models. The new color is called `second` and can use this color in the document with `\color{second}`. This color is also used for the new `link{}` command, see below.
16-
- Added a new `documentclass` option `titlecolor`, which allows you to set a separate color (compared to the header) of the titles.
12+
- Added a new `documentclass` option `colorharmony`, which defines a new color using color harmony models. The new color is called `second` and can be used in the document with `\color{second}`. This color is also used for the new `link{}` command, see below.
13+
- Added a new `documentclass` option `titlecolor`, which allows you to set a different color for the titles.
1714
- Defined a new command `\FAspace` which replaces the old length `\FAspace` (and therefore breaks compatibility with the v2 class file). Now you can use `\FAspace` directly in the document, instead of using `\hspace{\FAspace}`.
18-
- Defined a new command `\link{someurl.com}`, which places a fontawesome logo in the document with the link. The color is detemined using the color harmony models.
15+
- Defined a new command `\link{someurl.com}`, which places a fontawesome logo in the document with the link. The color of the logo is detemined using the color harmony models.
1916

2017

0 commit comments

Comments
 (0)