mirror of
https://github.com/moderncv/moderncv.git
synced 2026-02-06 10:05:19 +01:00
0a8a7c3702
Squash commits for adding user guide (#58) merge typo fixes from github.com/ig0774/moderncv set document encoding to utf8 move to inputenx package, remove pdflatex specific configurations to make everything compilable with lualatex get documentation compilable with xelatex get rough structure down and write how to read this manual finish getting started section and give template description its own section modify introduction to section two get basic setup section done add section on editing personal data adjust code indendation of listings. Get rid of obsolete examples rename some of the section headings to make them more consistent. fix some typos add version information to template and userguide remove pdfs completely from repo due to the new Makefile the pdf files have become obsolete in the repo. The new release rule of the make file creates all templates and the user guide and includes them into the tarball. In this way even users for which the linux based Makefile does not work can download precompiled examples and and the manual start section on fine tuning styles fix depricated comment explaining usage of \cvlistitem and \cvlistdoubleitem add section explaining how to adjust symbols and itemize lables add version information in title fix formulations and typos update package list with skillmatrix packages explain previously hidden options for casual style add bugs to known_bugs add explanation on how to use babel to guide add color explanation section explain orphaned section problem clean up old sections refine color section add macro descriptions of templates to user guide add instructions how to add signature and subject fix typo in changelog add missing social links in section describing personal data add missing social links in section describing how to change symbols first user guide version update README to latest local version fix(moderncvheadiii.sty): remove /null at the end of the address header. (#60) This removes the unnecesary newline there. Move space after title into conditional Don't break the title and quote formatting Correct font loading Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org> Remove baseurl in hyperref Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org> Fix footskip for fancyhdr in template Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org> Remove dot in cventry Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org> CI: don't update sources This only takes time and there aren't any relevant updates for us anyway. Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org> CI: scan for horizontal and vertical bad boxes Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org> Release v2.2.0 Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org> Mimic previous fontawesome look with fontawesome5 (#70) See: https://github.com/moderncv/moderncv/issues/67
71 lines
4.7 KiB
Markdown
71 lines
4.7 KiB
Markdown
# moderncv
|
|
|
|
## A modern curriculum vitae class for LaTeX
|
|
|
|
`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.
|
|
|
|
### 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=<style>`: Build the template in the style specified by
|
|
`<style>`. `<style>` can be classic, casual, banking, oldstyle or fancy.
|
|
|
|
* `templates:` Build the template `template.tex` with LuaLaTeX for _all moderncv styles_ and move resulting `pdf` files to the folder `examples/`.
|
|
|
|
* `userguide:` Build the user manual `manual/moderncv_userguide.tex` with `LuaLaTeX`. This rule calls the rule `templates` before compiling the documentation.
|
|
|
|
* `clean:` Clean the clutter created by compiling the documents.
|
|
|
|
* `delete:`Delete `template.pdf` and `manual/moderncv_userguide.pdf`.
|
|
|
|
* `deleteexamples:` Delete `examples/` folder and remaining template example `pdf` files in folder `manual/`.
|
|
|
|
* `force:` Force rebuilding the user guide by running the rules `delete` `deleteexamples` `userguide` and clean.
|
|
|
|
#### Rules intended for package maintainance
|
|
* `version:` Update the version information (version number and date) of all `moderncv` files (*.sty, moderncv.cls, *.tex). This rule can be called in two different ways. Note, however, that it is intended to be called by the rule `release` and usually does not need to be called explicitly.
|
|
* `make version`: Called in this way the version number is obtained through `git describe --tags`. If this information is newer all `moderncv` files get updated.
|
|
* `make version NEW=<version number>`: Optionally, the desired version number `<version number>` can be specified.
|
|
|
|
* `tarball:` Create a new release tarball suitable for upload to CTAN. If the `example/` folder is present, it gets included in the tar archive. Similary, all `pdf` files in the `manual/` folder get included aswell. This rule is intended to be called by the rule `release` and usually does not need to be called explicitly.
|
|
|
|
* `release:`Update the version information of all files including the subtitle
|
|
in the user guide, rebuild examples as well as the user
|
|
guide and create a releasable tarball including the compiled pdfs.
|
|
Before runing `make release` for an actual release be sure to tag the last
|
|
commit with the intended version information.
|
|
|
|
|
|
If using [`academicons`](https://ctan.org/tex-archive/fonts/academicons) in the template, you need to use a Xe(La)TeX or Lua(La)TeX engine for them to render. Otherwise an alternative will be used automatically.
|
|
|
|
## Development
|
|
|
|
[](https://github.com/moderncv/moderncv/actions/workflows/build-pdf.yml)
|
|
[](https://www.ctan.org/pkg/moderncv)
|
|
[](https://matrix.to/#/#moderncv:matrix.org)
|
|
|
|
As the main goal is to keep this package alive, it is maintained in a loosely structured team. You can contact us in our matrix room [moderncv:matrix.org](https://matrix.to/#/#moderncv:matrix.org), feel free to join if you have questions or want to contribute. Development takes place at [github.com/moderncv/moderncv](https://github.com/moderncv/moderncv).
|
|
|
|
## Licence
|
|
`moderncv` is licensed under the [LPPL-1.3c](https://spdx.org/licenses/LPPL-1.3c.html).
|
|
|
|
## Origin
|
|
Original author: Xavier Danaux <xdanaux@gmail.com><br/>
|
|
Original repository: https://github.com/xdanaux/moderncv<br/>
|
|
This repository is a fork aiming to maintain moderncv inside CTAN, since upstream is dead since 2016.
|