Skip to content

Commit

Permalink
update install notes
Browse files Browse the repository at this point in the history
see #326
  • Loading branch information
jcupitt committed Jan 11, 2022
1 parent 999e340 commit 1c32aa3
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
[![Test](https://github.com/libvips/ruby-vips/workflows/Test/badge.svg)](https://github.com/libvips/ruby-vips/actions?query=workflow%3ATest)

This gem is a Ruby binding for the [libvips image processing
library](https://libvips.github.io/libvips).
library](https://libvips.github.io/libvips). It has been tested on Linux,
macOs and Windows, and with ruby 2, ruby 3 and jruby. It uses [ruby-ffi](https://github.com/ffi/ffi) to call
functions in the libvips library.

libvips is a [demand-driven, horizontally
threaded](https://github.com/libvips/libvips/wiki/Why-is-libvips-quick)
Expand All @@ -14,32 +16,30 @@ memory](https://github.com/libvips/libvips/wiki/Speed-and-memory-use).
libvips is licensed under the [LGPL
2.1+](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html).

## Requirements
## Install on linux and macOS

* macOS, Linux, and Windows tested
Install the libvips binary with your package manager (eg. `apt install
libvips42` or perhaps `brew install vips`, see the [libvips install
instructions](https://libvips.github.io/libvips/install.html)) then install
this gem with:

* libvips 8.2 or later, see the [libvips install instructions](https://libvips.github.io/libvips/install.html)

* [ruby-ffi](https://github.com/ffi/ffi) 1.9 or later
```
gem install ruby-vips
```

* Ruby 2.0+, JRuby
Or include `gem "ruby-vips"` in your gemfile.

## Install
## Install on Windows

[Install libvips](https://libvips.github.io/libvips/install.html), then:
The gemspec will pull in the msys libvips for you, so all you need is:

```
$ gem install ruby-vips
gem install ruby-vips
```

or include it in `Gemfile`:

```ruby
gem "ruby-vips"
```
Or include `gem "ruby-vips"` in your gemfile.

On Windows, you'll need to set the `RUBY_DLL_PATH` environment variable to
point to the libvips bin directory.
Tested with the ruby and msys from choco.

## Example

Expand Down

0 comments on commit 1c32aa3

Please sign in to comment.