=head1 Perl bindings for the CommonMark C library

This module is a wrapper around I<libcmark>, the official CommonMark C
library.

=head2 Installation of libcmark

Please note that the I<libcmark> API isn't stable yet. This version of the
Perl bindings requires
L<version 0.18|https://github.com/jgm/cmark/releases/tag/0.18> and possibly
can't be compiled with later versions. For the time being, the version of
the Perl bindings is kept in sync with the I<libcmark> version.

    curl -LJO https://github.com/jgm/cmark/archive/0.18.tar.gz
    tar xzf cmark-0.18.tar.gz
    cd cmark-0.18
    make [INSTALL_PREFIX=/prefix]
    make test
    make install

See the I<libcmark> README for details.

=head2 Installation from a CPAN tarball

If I<libcmark> is in a standard location:

    perl Makefile.PL
    make
    make test
    make install

Otherwise:

    perl Makefile.PL \
        INC="-I/prefix/include" \
        LIBS="-L/prefix/lib -lcmark"
    make
    make test
    make install

See the documentation of I<ExtUtils::MakeMaker> for additional options.
The I<PERL_MM_OPT> environment variable is especially useful.

    export PERL_MM_OPT='INC="-I..." LIBS="-L... -lcmark"'

=head2 Build from a repository checkout 

You need I<Dist::Zilla> with the external plugin I<MakeMaker::Awesome>.
Then you can build and test with I<dzil>:

    dzil test
    dzil build

=head2 Copyright

This software is copyright (C) by Nick Wellnhofer.
 
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

