summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorChristophe Roger <darwiinc@live.fr>2016-11-09 06:01:47 +1100
committerChristophe Roger <darwiinc@live.fr>2016-11-09 06:01:47 +1100
commit59124741a72fbef06ce1c2c28dca186957c6b322 (patch)
treee826f1fd2256f9d5ef020bb83c3a4ceccc22a26c /README.md
parentf9bed6756070b4d4635882106c4512c0ade7b28f (diff)
downloadcv-59124741a72fbef06ce1c2c28dca186957c6b322.tar.gz
cv-59124741a72fbef06ce1c2c28dca186957c6b322.tar.bz2
cv-59124741a72fbef06ce1c2c28dca186957c6b322.tar.xz
cv-59124741a72fbef06ce1c2c28dca186957c6b322.zip
Updated README.md with informations on how to use documentclass options
Diffstat (limited to 'README.md')
-rwxr-xr-xREADME.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 96adc6c..c34f639 100755
--- a/README.md
+++ b/README.md
@@ -21,6 +21,25 @@ You can edit online **Awesome Source Latex CV** on [Overleaf](https://www.overle
## How to use **Awesome Source CV** latex class
+### Use the **Awesome Source CV** options
+
+When declaring the `\documentclass` you can use some option(s) to customize your CV rendering.
+
+```latex
+% Used with no option, the template will use the 'traditional'
+% header formatting your system fonts and the default color scheme
+\documentclass{awesome-source-cv}
+
+% Used with localFont option the template will use the 'traditional'
+% header formatting, fonts included in the fonts directory and the default color scheme
+\documentclass[localFont]{awesome-source-cv}
+
+% Used with localFont option, the template will use the 'alternative'
+% header formatting, your system fonts and the default color scheme
+\documentclass[alternative]{awesome-source-cv}
+
+```
+
### Construct the header
Outside of the `\socialinfo` wrapper you have to define the mandatory parameters `\name` and `\tagline`.