summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
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`.