github/moderncv
1
0
Fork 0
mirror of https://github.com/moderncv/moderncv.git synced 2026-02-06 10:05:19 +01:00
Code Issues Projects Releases Packages Wiki Activity

update readme. include automatic version in title of user guide

Browse source
This commit is contained in:
David 2021-01-25 22:56:12 +01:00
commit a2ec1ecd06
2 changed files with 12 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -20,7 +20,7 @@ The user guide can be found in the folder `manual` and contains additional infor
### Makefile
The `Makefile` supports the following rules.
#### Rules intended for regular use
#### 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 casual style.
* `make template STYLE=<style>`: Build the template in the style specified by
@ -38,15 +38,18 @@ The `Makefile` supports the following rules.
* `force:` Force rebuilding the user guide by running the rules `delete` `deleteexamples` `userguide` and clean `clean
#### Rules intended for package maintainers
#### 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, rebuild examples as well as the user guide and create a releasable tarball including everything. In this way the tarball on CTAN contains ready made pdf files.
* `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 copiled pdfs.
Before runing `make release` for an actual release be sure to tag the last
commit with the intended version information.
## Licence