README.textile 8.46 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
h1. RMagick

!https://img.shields.io/gem/v/rmagick.svg?style=flat(RubyGems)!:http://rubygems.org/gems/rmagick !https://img.shields.io/gem/dt/rmagick.svg?style=flat! !https://www.versioneye.com/ruby/rmagick/reference_badge.svg?style=flat(VersionEye)!:https://www.versioneye.com/ruby/rmagick/references !https://img.shields.io/travis/rmagick/rmagick/master.svg?style=flat(Travis CI)!:https://travis-ci.org/rmagick/rmagick !https://img.shields.io/codeclimate/github/rmagick/rmagick.svg?style=flat(Code Climate)!:https://codeclimate.com/github/rmagick/rmagick !https://badges.gitter.im/Join%20Chat.svg(Gitter)!:https://gitter.im/rmagick/rmagick?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

h3. Table of Contents

* "Introduction":#intro
* "Prerequisites":#prereq
* "Installing RMagick":#install
* "Things that can go wrong":#wrong
* "Upgrading":#upgrade
* "More samples":#samples
* "Reporting Bugs":#bugs
* "Development Setup":#dev-setup
* "Contact Information":#contact
* "Credits":#credits
* "License":#license
* "Releasing":#releasing

h2(#intro). Introduction

RMagick is an interface between the Ruby programming language and the
ImageMagick image processing library.

h2(#prereq). Prerequisites

*O/S* Linux, *BSD, OS X, Windows 2000, XP, Vista, other *nix-like systems.

*Ruby* Version 1.8.5 or later. You can get Ruby from "www.ruby-lang.org":http://www.ruby-lang.org.

Ruby must be able to build C-Extensions (e.g. MRI, Rubinius, not JRuby)

*ImageMagick* Version 6.4.9 or later. You can get ImageMagick from "www.imagemagick.org":http://www.imagemagick.org.

On Ubuntu, you can run:

bc. sudo apt-get install libmagickwand-dev

39 40
*Note to Windows users:* Please make sure that you choose an ImageMagick version that matches the bitness of your Ruby version.

41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
h2(#install). Installing RMagick

h4. Installing via Bundler

Add to your `Gemfile`:

bc. gem 'rmagick'

Then run:

bc. bundle install

h4. Installing via RubyGems

Run:

bc. gem install rmagick

59 60 61 62 63 64 65 66
h4. Versioning

RMagick is versioned according to Semantic Versioning.
For stable version compatible with Ruby 1.8+, use `~> 2.0`.
Upcoming version 3 will work on Ruby 2.x only.

h2(#usage). Using RMagick

67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
Require RMagick in your project as follows:

bc. require 'rmagick'

h2(#wrong). Things that can go wrong

The "RMagick installation FAQ":https://web.archive.org/web/20140512193354/http://rmagick.rubyforge.org/install-faq.html
has answers to the most commonly reported problems, though may be out of date.

h4. Can't install RMagick. Can't find libMagick or one of the dependent libraries. Check the mkmf.log file for more detailed information.

Typically this message means that one or more of the libraries that ImageMagick
depends on hasn't been installed. Examine the mkmf.log file in the ext/RMagick
subdirectory of the installation directory for any error messages. These messages
typically contain enough additional information for you to be able to diagnose
the problem. Also see "this FAQ":https://web.archive.org/web/20140512193354/http://rmagick.rubyforge.org/install-faq.html#libmagick.

On OS X with Homebrew, try [re]installing pkg-config:

<pre>
brew uninstall pkg-config
brew install pkg-config
brew unlink pkg-config
brew link pkg-config
</pre>

h4. Cannot open shared object file

If you get a message like this:

<pre>
    $DIR/RMagick.rb:11:in `require': libMagick.so.0:
      cannot open shared object file: No such file or directory -
      $DIR/RMagick2.so (LoadError)
</pre>

you probably do not have the directory in which the ImageMagick library
is installed in your load path.  An easy way to fix this is to define
the directory in the LD_LIBRARY_PATH environment variable.  For
example, suppose you installed the ImageMagick library libMagick.so in
/usr/local/lib.  (By default this is where it is installed.) Create the
LD_LIBRARY_PATH variable like this:

<pre>
        export LD_LIBRARY_PATH=/usr/local/lib
</pre>

On Linux, see @ld(1)@ and @ld.so(8)@ for more information. On other operating
systems, see the documentation for the dynamic loading facility.

h4. Segmentation fault

Default stack size of your operating system might be too small. Try removing the limit with this command:

<pre>
        ulimit -s unlimited
</pre>

h2(#upgrade). Upgrading

If you upgrade to a newer release of ImageMagick, make sure you're using a
release of RMagick that supports that release. It's safe to install a new
release of RMagick over an earlier release.

h2(#samples). More samples

You can find more sample RMagick programs in the /example directory.
These programs are not installed in the RMagick documentation tree.

h2(#bugs). Reporting bugs

Please report bugs in RMagick, its documentation, or its installation
programs to me via the bug tracker on the "RMagick issues page":https://github.com/rmagick/rmagick/issues

However, I can't help with Ruby installation and configuration or ImageMagick
installation and configuration. Information about reporting problems and
getting help for ImageMagick is available at the "ImageMagick web site":http://www.imagemagick.org
or the "ImageMagick Forum":http://www.imagemagick.org/discourse-server.

h2(#dev-setup). Development Setup

In order to minimize issues on your local machine, we recommend that you make
use of a "Vagrant installation":https://github.com/tjschuck/rake-compiler-dev-box.

Steps to get up and running with a passing build are as follows:

h4. 1) set up the Vagrant environment

If you don't already have Vagrant installed, you can download and install it
from "here":https://www.vagrantup.com/. Once installed, we can set up a pre-built environment:

<pre>
git clone https://github.com/tjschuck/rake-compiler-dev-box.git
cd rake-compiler-dev-box
vagrant up
</pre>

This last part will probably take a while as it has to download an Ubuntu image
and configure it. If there is an error during this process, you may need to
reboot your computer and enable virtualization in your BIOS settings.

h4. 2) clone RMagick and log in to the vagrant box

Within the `rake-compiler-dev-box` directory:

<pre>
git clone https://github.com/rmagick/rmagick.git # or your fork
vagrant ssh
</pre>

h4. 3) install ImageMagick and additional environment stuff

<pre>
cd /vagrant/rmagick
export IMAGEMAGICK_VERSION=6.6.9-10 # the only known passing version as of this writing
sh ./before_install_linux.sh
</pre>

This will take just a few minutes to build ImageMagick

h4. 4) build RMagick

<pre>
rake
</pre>

This compiles the RMagick extensions and runs the tests. If all goes well
you'll see a lot of output, eventually ending in something like:

<pre>
Finished tests in 35.865734s, 11.3758 tests/s, 6560.3007 assertions/s.

408 tests, 235290 assertions, 0 failures, 0 errors, 0 skips
</pre>

And you're all set! The copy of RMagick within `/vagrant/rmagick` inside your
Vagrant session is the same as the one in the `rake-compiler-dev-box` directory
on your machine. You can make changes locally and run tests within your `ssh`
session.

h2(#contact). Contact Information

*Author:* Tim Hunter, Omer Bar-or, Benjamin Thomas

h2(#credits). Credits

Thanks to "ImageMagick Studio LLC":http://www.imagemagick.org for ImageMagick
and for hosting the RMagick documentation.

h2(#license). MIT License

<pre>
Copyright &copy; 2002-2009 by Timothy P. Hunter

Changes since Nov. 2009 copyright &copy; by Benjamin Thomas and Omer Bar-or

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
</pre>

<hr>

h2(#releasing). Releasing

See https://github.com/rmagick/rmagick/wiki/Release-Process

# Update ChangeLog
# Edit lib/rmagick/version.rb
# Are the tests passing? Run `rake` again just to be sure.
# `rake release`