From e13a39422df5b06349d33302f3e88f4dc0b8af22 Mon Sep 17 00:00:00 2001 From: Laurence Withers Date: Sat, 3 Jan 2009 23:07:40 +0000 Subject: [PATCH] Add some simple instructions --- README | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README b/README index 209c05e..f0de715 100644 --- a/README +++ b/README @@ -22,3 +22,23 @@ used to compile, dump or verify the contents of a table of leap seconds in a format suitable for loading with libiso8601. See http://www.lwithers.me.uk/usr/src/libiso8601/ for details. + +Instructions +------------ + +Use --help for usage info. + +In compile mode, it takes a text file (or stdin) with an ISO8601-format +date on each line. Each date corresponds to a day with a positive leap +second, e.g.: + + 2005-06-30 + 2005-12-31 + 2008-12-31 + +This file is compiled into the binary format expected by libiso8601's +iso8601_leap_table_load() function. + +In dump mode, the binary file is dumped into a text file. In verify +mode, the library is used to load a compiled file, and some basic tests +are performed to check the library behaviour matches what is expected.