diff options
| author | Mason James <mtj@kohaaloha.com> | 2023-01-25 16:39:47 +1300 |
|---|---|---|
| committer | Mason James <mtj@kohaaloha.com> | 2023-01-25 16:39:47 +1300 |
| commit | 33f5ae7a7b2f01d0d96b81525518986e8f500eee (patch) | |
| tree | 4ec73598cd105889450a53bcbb8d9810dc156623 /readme.md | |
Import original source of Color-Spectrum 1.14
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..05cb2d2 --- /dev/null +++ b/readme.md @@ -0,0 +1,45 @@ +Color::Spectrum +=============== +Just another HTML color generator. [](https://metacpan.org/pod/Color::Spectrum) [](https://travis-ci.org/jeffa/Color-Spectrum) + +Synopsis +-------- +```perl +# Procedural interface: +use Color::Spectrum qw(generate); +my @color = generate(10,'#000000','#FFFFFF'); + +# OO interface: +use Color::Spectrum; +my $spectrum = Color::Spectrum->new(); +my @color = $spectrum->generate(10,'#000000','#FFFFFF'); +``` + +Installation +------------ +To install this module, you should use CPAN. A good starting +place is [How to install CPAN modules](http://www.cpan.org/modules/INSTALL.html). + +If you truly want to install from this github repo, then +be sure and create the manifest before you test and install: +``` +perl Makefile.PL +make +make manifest +make test +make install +``` + +Support and Documentation +------------------------- +After installing, you can find documentation for this module with the +perldoc command. +``` +perldoc Color::Spectrum +``` + +You can also find documentation at [metaCPAN](https://metacpan.org/pod/Color::Spectrum). + +License and Copyright +--------------------- +See [source POD](/lib/Color/Spectrum.pm). |