[tz] [PROPOSED 5/5] Improve README

Paul Eggert eggert at cs.ucla.edu
Sun Nov 19 21:30:15 UTC 2023

Emphasize reading Makefile comments a bit more, and say
that the leading comments are the important ones.

Give advice that works even if $HOME contains whitespace.
 README | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

diff --git a/README b/README
index 145aacd4..edabd2e0 100644
--- a/README
+++ b/README
@@ -11,14 +11,17 @@ changes made by political bodies to time zone boundaries, UTC offsets,
 and daylight-saving rules.
 See <https://www.iana.org/time-zones/repository/tz-link.html> or the
-file tz-link.html for how to acquire the code and data.  Once acquired,
-read the comments in the file 'Makefile' and make any changes needed
-to make things right for your system, especially if you are using some
-platform other than GNU/Linux.  Then run the following commands,
-substituting your desired installation directory for "$HOME/tzdir":
-	make TOPDIR=$HOME/tzdir install
-	$HOME/tzdir/usr/bin/zdump -v America/Los_Angeles
+file tz-link.html for how to acquire the code and data.
+Once acquired, read the leading comments in the file "Makefile"
+and make any changes needed to make things right for your system,
+especially when using a platform other than current GNU/Linux.
+Then run the following commands, substituting your desired
+installation directory for "$HOME/tzdir":
+	make TOPDIR="$HOME/tzdir" install
+	"$HOME/tzdir/usr/bin/zdump" -v America/Los_Angeles
 See the file tz-how-to.html for examples of how to read the data files.

More information about the tz mailing list