diff --git a/README.md b/README.md index d87ba73..3d9bede 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,52 @@ **moderncv** provides a documentclass for typesetting curricula vitae in various styles. Moderncv aims to be both straightforward to use and customizable, providing five ready-made styles (classic, casual, banking, oldstyle and fancy) and allowing one to define his own by modifying colors, fonts, icons, etc. Most commands are defined in such a way that arguments are optional. +### Getting started +Once you clone this repo have a look at some examples and build the manual to see if this package suits your needs. +This can be done by issuing +```make +make userguide +``` +in a terminal. After completion of the compilation precompiled versions of the template in all styles can be found in the folder `examples` and +the user guide in the folder `manual`. +Alternatively get the tar ball from [CTAN](https://ctan.org/pkg/moderncv?lang=de). The examples as well as the documentation are already prebuilt in that tarball. + +To start working on your own application use and modify the template file `template.tex`. +The user guide can be found in the folder `manual` and contains additional information on what the document class offers. + +### Makefile +The `Makefile` supports the following rules. + +#### Rules for building templates and the user guide +* `template:` Build the `moderncv` template `template.tex` with `LuaLaTeX`. This rule can be called in one of two ways: + * `make template`: Build the template in default style. + * `make template STYLE=