Skip to content

Commit 1c32aa3

Browse files
committed
update install notes
see #326
1 parent 999e340 commit 1c32aa3

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
[![Test](https://github.com/libvips/ruby-vips/workflows/Test/badge.svg)](https://github.com/libvips/ruby-vips/actions?query=workflow%3ATest)
55

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

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

17-
## Requirements
19+
## Install on linux and macOS
1820

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

21-
* libvips 8.2 or later, see the [libvips install instructions](https://libvips.github.io/libvips/install.html)
22-
23-
* [ruby-ffi](https://github.com/ffi/ffi) 1.9 or later
26+
```
27+
gem install ruby-vips
28+
```
2429

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

27-
## Install
32+
## Install on Windows
2833

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

3136
```
32-
$ gem install ruby-vips
37+
gem install ruby-vips
3338
```
3439

35-
or include it in `Gemfile`:
36-
37-
```ruby
38-
gem "ruby-vips"
39-
```
40+
Or include `gem "ruby-vips"` in your gemfile.
4041

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

4444
## Example
4545

0 commit comments

Comments
 (0)