From 8b38aaa1a3ab5b884abcc9d410ceaeba6f06bce9 Mon Sep 17 00:00:00 2001
From: David <forenkram@gmx.de>
Date: Mon, 25 Jan 2021 22:56:12 +0100
Subject: [PATCH] update readme. include automatic version in title of user
 guide

---
 Makefile  |  8 +++++---
 README.md | 11 +++++++----
 2 files changed, 12 insertions(+), 7 deletions(-)

diff --git a/Makefile b/Makefile
index 591c0fd..eacaf5e 100644
--- a/Makefile
+++ b/Makefile
@@ -5,14 +5,14 @@ MANUALDIR = $(MODERNCVDIR)/manual
 
 # version and date of the current release. This gets updated upon calling
 # either the rule version or the rule release
-VERSION = v2.1.0
-VERSIONDATE = 2021/01/21
+VERSION = v2.1.0-40-gfe4d968-dirty
+VERSIONDATE = 2021/01/25
 # user callable NEW option, to specify the new version. If unspecified, the
 # new version gets determined by git.
 ifdef NEW
     VERSIONNEXT = $(NEW)
 else
-    VERSIONNEXT = $(shell git describe --tags)
+    VERSIONNEXT = $(shell git describe --tags --dirty)
 endif
 VERSIONDATENEXT = $(shell date +"%Y\/%m\/%d")
 TARBALL=moderncv-$(VERSIONNEXT).tar
@@ -97,6 +97,8 @@ version:
 				if [[ -f "$$file" ]] && [[ ! -h "$$file" ]]; then
 					echo "updating version info of file $$file to $(VERSIONNEXT) (was $(VERSION))";
 					sed -i "s/$$findstr/$$replacestr/g" $$file;
+					# update version info in the title of documentation
+					sed -i "s/Package version $(VERSION)}/Package version $(VERSIONNEXT)}/g" $$file;
 				fi
 			done
 		done
diff --git a/README.md b/README.md
index cd07741..663028b 100644
--- a/README.md
+++ b/README.md
@@ -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