summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/limecv/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/limecv/README.md')
-rw-r--r--macros/latex/contrib/limecv/README.md64
1 files changed, 64 insertions, 0 deletions
diff --git a/macros/latex/contrib/limecv/README.md b/macros/latex/contrib/limecv/README.md
new file mode 100644
index 0000000000..c50155f639
--- /dev/null
+++ b/macros/latex/contrib/limecv/README.md
@@ -0,0 +1,64 @@
+# limecv <img src="src/images/limecv-icon.png" alt="limecv project icon" width="40px"/>
+
+`limecv` is a document class to typeset curriculum vitæ in (Xe/Lua)LaTeX.
+
+The design of this document class is detailed in [a series of blog posts][blog].
+
+Example CV:
+
+<div>
+ <img src="images/cv.png" alt-="CV example" width="300px"/>
+ <img src="images/cover_letter.png" alt-="cover letter example" width="300px"/>
+</div>
+
+`limecv` offers support for a bio/profile, contact details, language skills, (general) skills, projects, education, experience and references. It also features a custom cover letter design.
+
+## Installation
+
+The package is [available from CTAN](https://ctan.org/pkg/limecv), so you should use a package manager to install this package.
+
+After installing this package, make sure you have the following fonts installed:
+
+* [FontAwesome][FA]
+* [Fira][fira] (only needed when using XeLaTeX/LuaLaTeX)
+
+The following packages need to be installed on your system. They are all available on CTAN:
+`kvoptions`,
+`ifxetex`,
+`ifluatex`,
+`xparse`,
+`calc`,
+`xcolor`,
+`tabularx`,
+`hyperref`,
+`url`,
+`parskip`,
+`xstring`,
+`xkeyval`,
+`tikz`,
+`graphicx`,
+`fontspec` (XeLaTeX and LuaLaTeX only) and
+`fontawesome`.
+
+## Documentation
+
+The class documentation can be found on [CTAN](http://mirrors.ctan.org/macros/latex/contrib/limecv/limecv.pdf).
+
+Alternatively, the documentation can also be created by running `pdflatex limecv.dtx`.
+
+## Examples
+
+To compile the examples in `/examples/`, install the package from CTAN or compile from source by running: `pdflatex limecv.ins` and copy the resulting `limecv.cls` file to the `/examples/` folder.
+
+## Licence
+
+LPPL v1.3c See LICENSE file.
+
+Default profile picture courtesy of Twitter.
+
+© 2017 Olivier Pieters
+
+[blog]: https://olivierpieters.be/blog/archive/tag/limecv
+[FA]: http://fontawesome.io
+[fira]: https://github.com/mozilla/Fira
+[docs]: http://ctan.org/tex-archive/macros/generic/limecv/limecv.pdf