README.md

ColorGradient

This, my first ever gem, takes a gradient calculation class created by Tom Pesman, and makes it use Color gem objects.

Installation

Add this line to your application's Gemfile:

gem 'color_gradient'

And then execute:

$ bundle

Or install it yourself as:

$ gem install color_gradient

Usage

start = Color::RGB.new(0, 0, 0)
stop = Color::RGB.new(255, 255, 255)
resolution = 7

color_gradient = ColorGradient.new(start, stop, resolution)

# Each of the following returns a Color gem object for the colour relating to that step
color_gradient.gradient(0)
color_gradient.gradient(1)
color_gradient.gradient(2)
color_gradient.gradient(3)
color_gradient.gradient(4)
color_gradient.gradient(5)
color_gradient.gradient(6)
color_gradient.gradient(7)

# Or use as enumerable object
color_gradient.each do |colour|
  do_something(colour)
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/LimeBlast/color_gradient.

License

The gem is available as open source under the terms of the MIT License.