Maintainer's Corner

Readme for htoml-megaparsec-2.0.0.1

htoml

TOML is the obvious, minimal configuration language by
Tom Preston-Werner.
It is an alternative to the XML,
YAML and
INI formats mainly for the purpose of
configuration files. Many will find that XML and YAML are too heavy for
the purpose of configuration files prupose while INI is underspecified.
TOML is to configuration files, like what Markdown is for rich-text.

Quick start

In order to make your project depend on it you can add it as a
dependency in your project's .cabal file, and since it is not
yet on Stackage you will also have
to add it to the extra-deps section of your stack.yaml file
when using Stack.

To quickly show some features of htoml we use Stack to start a
GHCi-based REPL. It picks up configuration from the .ghci file
in the root of the repository.

The second main option is to use the toJSON function to transform the data
to an Aeson data structure,
after which you can use your Aeson toolbelt to tackle the problem. Since
TOML is intended to be a close cousin of JSON this is a very practical
approach.

Other ways to pull data from a parsed TOML document will most likely
exist; possible using the lens library as
documented here.

Compatibility

Currently we are testing against several versions of GHC with
Travis CI as defined in the env section of our
.travis.yml.
lts-2 implies GHC 7.8.4, lts-3 implies GHC 7.10.2, lts-4/lts-5
imply GHC 7.10.3, and nightly is build with a regularly updated version of GHC.

Version contraints of htoml's dependencies

If you encounter any problems because htoml's dependecies are
constrained either too much or too little, please
file a issue for that.
Or off even better submit a PR.