# Math::Polygon

  * My extended documentation: <http://perl.overmeer.net/CPAN/>
  * Development via GitHub: <https://github.com/markov2/perl-Math-Polygon>
  * Download from CPAN: <ftp://ftp.cpan.org/pub/CPAN/authors/id/M/MA/MARKOV/>
  * Indexed from CPAN: <http://search.cpan.org/~markov/Math-Polygon/>
    and <https://metacpan.org/release/Math-Polygon>

This module supports simple manipulation of 2D polygons, via two interfaces:

1. Object Oriented via Math::Polygon

   This is the preferred interface: the simplest when you understand OO.
   The polygon coordinates (ARRAY of points) are wrapped into an abstract
   objects.

2. Function interface via Math::Polygon::Calc and friends

   When you prefer to use plain functions and ARRAYs of ARRAYs of
   coordinates.

## Development &rarr; Release

Important to know, is that I use an extension on POD to write the manuals.
The "raw" unprocessed version is visible on GitHub.  It will run without
problems, but does not contain manual-pages.

Releases to CPAN are different: "raw" documentation gets removed from
the code and translated into real POD and clean HTML.  This reformatting
is implemented with the OODoc distribution (A name I chose before OpenOffice
existed, sorry for the confusion)

Clone git for the "raw" version.  On github, you can find the processed
version for each release.  But the better source is CPAN:

```sh
   cpan -i Math::Polygon
```

## Contributing

When you want to contribute to this module, you do not need to provide
a perfect patch... actually: it is nearly impossible to create a patch
which I will merge without modification.  Usually, I need to adapt the
style of code and documentation to my own strict rules.

When you submit an extension, please contribute a set with

1. code

2. code documentation

3. regression test in t/

**Please note:**
When you contribute in any way, you agree to transfer the copyrights to
Mark Overmeer (you will get the honors in the code and/or ChangeLog).
Your also automatically agree that your contribution is released under
the same license as this project: licensed as perl itself.

## Copyright and License

This project is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See <http://dev.perl.org/licenses/>

