summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rwxr-xr-xREADME.md30
1 files changed, 29 insertions, 1 deletions
diff --git a/README.md b/README.md
index 32e7775..bb8b268 100755
--- a/README.md
+++ b/README.md
@@ -21,12 +21,18 @@ You can edit online **Awesome Source Latex CV** on [Overleaf](https://www.overle
## How to use **Awesome Source CV** latex class
+### Construct the header
+
```latex
% Define author's name
% Usage: \name{<firstname>}{<lastname>}
% Mandatory
\name{Christophe}{ROGER}
+% Define author's photo (optional)
+% Usage \photo{<diameter>}{<photo>}
+\photo{2.5cm}{darwiin}
+
% Define author's tagline
% Usage: \tagline{<tag line>}
% Mandatory
@@ -34,6 +40,26 @@ You can edit online **Awesome Source Latex CV** on [Overleaf](https://www.overle
```
```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}
+
+% Render author's email (optional)
+% Usage: \email{<email adress>}
+\email{christophe.roger@mail.com}
+```
+
+The command above must be integrated in the `\socialinfo` wrapper
+
+```latex
\socialinfo{
\linkedin{christopheroger}
\viadeo{christopheroger}
@@ -45,7 +71,9 @@ You can edit online **Awesome Source Latex CV** on [Overleaf](https://www.overle
}
```
-To describe your experiences you have first to declare the **experiences** environment
+### Construct the _experiences_ section
+
+To describe your experiences you have first to declare the `experiences` environment
```latex
% Begin a new experiences environment to use experience and consultantexperience macro