diff --git a/.gitignore b/.gitignore index 84f231c..3212bef 100644 --- a/.gitignore +++ b/.gitignore @@ -15,3 +15,5 @@ template.pdf # release tarballs moderncv-*.tar.gz + +examples/ diff --git a/KNOWN_BUGS b/KNOWN_BUGS index 15b86ec..05cb6af 100644 --- a/KNOWN_BUGS +++ b/KNOWN_BUGS @@ -1,3 +1,6 @@ +- skillmatrix does not break automatically in fancystyle. +- long names break the oldstyle and possibly other styles (needs testing). +- long urls in classic style can make the name break line. Fixed width for the adresspart must be implemented. - When using the "fancy" style, undesired space is added between the bibliography head and the first entry, as well as after the last entry - Moderncv is incompatible with biblatex. diff --git a/README.md b/README.md index 7a78a30..eeec599 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,55 @@ ## A modern curriculum vitae class for LaTeX -**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. +`moderncv` provides a documentclass for typesetting applications (curricula vitae and cover letters) 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=