git.lirion.de

Of git, get, and gud

aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorH. P. <harald.p.@xmart.de> 2018-09-29 16:47:38 +0200
committerH. P. <harald.p.@xmart.de> 2018-09-29 16:47:38 +0200
commitcf745909e772b707f959b742e1e71633fd5128d9 (patch)
tree564bb941068198880fefe47894299b027bc9a66a
parent6589dc659146a12296b8cedb39bda2be3d38b8c3 (diff)
downloadtimewarrior-holidays-cf745909e772b707f959b742e1e71633fd5128d9.tar.bz2
Update of README to match the current version
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4d0ca29..dded2bc 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
## Timewarrior Holiday Files
-These files were created manually for now (script maybe following).
+The holidays files were created maually for now.
They contain following files:
@@ -12,6 +12,21 @@ They contain following files:
only are an auxiliary display anyway), we will mark them as
"VAC" and are done with it.
+### refresh script
+
+Since the refresh script included in the holidays plugin is not working, I'm
+creating my own. I'm not a python zen guru, so this is rather slow development.
+However, the current state is the following:
+
+* You can pass on the desired locale (e.g. de-DE) and the desired year to the
+script (call it with --help to see details). It will then create files for all
+of the regions and the country's allover holidays.
+* --region is not functional yet, this will be included soon.
+* If you don't supply --locale, for now it will draw de-DE by default. In
+future versions it will work like the original script, i.e. refresh all
+existing files (this will come after the implementation of --region as that is
+a prerequisite).
+
### ISO-3166-2 codes
The following tables are just explanatives - if you know your ISO-3166, you can