diff --git a/LICENSE b/LICENSE --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2010 Yitzchak Gale. All rights reserved. +Copyright (c) 2010-2015 Yitzchak Gale. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are diff --git a/README b/README deleted file mode 100644 --- a/README +++ /dev/null @@ -1,49 +0,0 @@ -timezone-olson version 0.1.0 - -This package provides a parser and renderer for binary Olson timezone -files whose format is specified by the tzfile(5) man page on Unix-like -systems. For more information about this format, see -. Functions are provided for -converting the parsed data into 'TimeZoneSeries' objects from the -timezone-series package. On many platforms, binary Olson timezone -files suitable for use with this package are available in the -directory /usr/share/zoneinfo and its subdirectories on your computer. - -This version of timezone-olson is highly experimental. Expect there -to be bugs, and do not rely on any stability of the exposed -interfaces. - -Copyright (c) 2010 Yitzchak Gale. All rights reserved. -For licensing information, see the BSD3-style license in the file -LICENSE that was originally distributed by the author together with -this file. - -This package is part of the time-ng project: -http://projects.haskell.org/time-ng/ - -Send suggestions, bug reports, and patches to: -yitz@community.haskell.org - -INSTALLATION: - -To install the latest version of this package, make sure that -cabal-install is installed on your system (it is if you have installed -the Haskell Platform) and type the commands: - -cabal update -cabal install timezone-olson - -TESTING UTILITIES: - -This package also provides two Haskell files, each of which can be -compiled into a command-line utility that might be helpful for testing -purposes. - -zhdump.hs: A clone of zdump(8), including most of its bugs, that - is usually present on systems that have an Olson timezone - database, except hzdump takes paths to timezone files - instead of timezone identifiers on the command line. - -catTZ: Read and parse a timezone file, then render it. With the - -i flag, interprets the timezone data as a TimeZoneSeries - object before rendering. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# timezone-olson + +On Hackage: [timezone-olson](http://hackage.haskell.org/package/timezone-olson) + +This package provides a parser and renderer for binary Olson timezone +files whose format is specified by the tzfile(5) man page on Unix-like +systems. For more information about this format, see +[the IANA timezone database site](https://www.iana.org/time-zones). + +Functions are provided for +converting the parsed data into `TimeZoneSeries` objects from the +[timezone-series](http://hackage.haskell.org/package/timezone-series) +package. On many platforms, binary Olson timezone +files suitable for use with this package are available in the +directory `/usr/share/zoneinfo` and its subdirectories on your computer. + +See also the +[timezone-olson-th](http://hackage.haskell.org/package/timezone-olson-th) +package for a way to include timezone informaton from a binary Olson +timezone file at compile time. + +Copyright (c) 2010-2015 Yitzchak Gale. All rights reserved. + +For licensing information, see the BSD3-style license in the file +LICENSE that was originally distributed by the author together with +this file. + +This package is part of the [time-ng project](http://projects.haskell.org/time-ng/). + +## Testing utilities + +This package also provides two Haskell files, each of which can be +compiled into a command-line utility that might be helpful for testing +purposes. + +zhdump.hs: A clone of zdump(8), including most of its bugs, that + is usually present on systems that have an Olson timezone + database, except hzdump takes paths to timezone files + instead of timezone identifiers on the command line. + +catTZ: Read and parse a timezone file, then render it. With the + -i flag, interprets the timezone data as a TimeZoneSeries + object before rendering. diff --git a/timezone-olson.cabal b/timezone-olson.cabal --- a/timezone-olson.cabal +++ b/timezone-olson.cabal @@ -1,18 +1,6 @@ --- timezone-olson.cabal auto-generated by cabal init. For additional --- options, see --- http://www.haskell.org/cabal/release/cabal-latest/doc/users-guide/authors.html#pkg-descr. --- The name of the package. Name: timezone-olson - --- The package version. See the Haskell package versioning policy --- (http://www.haskell.org/haskellwiki/Package_versioning_policy) for --- standards guiding when and how versions should be incremented. -Version: 0.1.6 - --- A short (one-line) description of the package. +Version: 0.1.7 Synopsis: A pure Haskell parser and renderer for binary Olson timezone files - --- A longer description of the package. Description: A parser and renderer for binary Olson timezone files whose format is specified by the tzfile(5) man page on Unix-like systems. For more @@ -24,53 +12,29 @@ files suitable for use with this package are available in the directory /usr/share/zoneinfo and its subdirectories on your computer. - --- URL for the project homepage or repository. Homepage: http://projects.haskell.org/time-ng/ - --- The license under which the package is released. License: BSD3 - --- The file containing the license text. License-file: LICENSE - --- The package author(s). Author: Yitzchak Gale - --- An email address to which users can send suggestions, bug reports, --- and patches. Maintainer: yitz@sefer.org - --- A copyright notice. -Copyright: Copyright (c) 2010 Yitzchak Gale. All rights reserved. - +Copyright: Copyright (c) 2010-2015 Yitzchak Gale. All rights reserved. Category: Data - Build-type: Simple - --- Extra files to be distributed with the package, such as examples or --- a README. -Extra-source-files: README, catTZ.hs, hzdump.hs - --- Constraint on the version of Cabal needed to build this package. -Cabal-version: >=1.2 - +Extra-source-files: README.md, catTZ.hs, hzdump.hs +Cabal-version: >=1.10 +Source-repository HEAD + type: git + location: https://github.com/ygale/timezone-olson.git Library - -- Modules exported by the library. - Exposed-modules: Data.Time.LocalTime.TimeZone.Olson, Data.Time.LocalTime.TimeZone.Olson.Parse, Data.Time.LocalTime.TimeZone.Olson.Render, Data.Time.LocalTime.TimeZone.Olson.Types - - -- Packages needed in order to build this package. + Default-language: Haskell2010 + Exposed-modules: Data.Time.LocalTime.TimeZone.Olson + , Data.Time.LocalTime.TimeZone.Olson.Parse + , Data.Time.LocalTime.TimeZone.Olson.Render + , Data.Time.LocalTime.TimeZone.Olson.Types Build-depends: base >= 3.0 && < 5.0, timezone-series >= 0.1.0 && < 0.2, - time >= 1.1.4 && < 1.5, + time >= 1.1.4 && < 1.6, binary >= 0.4.1 && < 0.8, bytestring >= 0.9 && < 1.0, extensible-exceptions >= 0.1.0 && < 0.2 - - -- Modules not exported by this package. - -- Other-modules: - - -- Extra tools (e.g. alex, hsc2hs, ...) needed to build the source. - -- Build-tools: -