Add some simple instructions

This commit is contained in:
Laurence Withers 2009-01-03 23:07:40 +00:00
parent 67c96e40bb
commit e13a39422d
1 changed files with 20 additions and 0 deletions

20
README
View File

@ -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.