4
4
[ ![ Test] ( https://github.com/libvips/ruby-vips/workflows/Test/badge.svg )] ( https://github.com/libvips/ruby-vips/actions?query=workflow%3ATest )
5
5
6
6
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.
8
10
9
11
libvips is a [ demand-driven, horizontally
10
12
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).
14
16
libvips is licensed under the [ LGPL
15
17
2.1+] ( https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html ) .
16
18
17
- ## Requirements
19
+ ## Install on linux and macOS
18
20
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:
20
25
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
+ ```
24
29
25
- * Ruby 2.0+, JRuby
30
+ Or include ` gem "ruby-vips" ` in your gemfile.
26
31
27
- ## Install
32
+ ## Install on Windows
28
33
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 :
30
35
31
36
```
32
- $ gem install ruby-vips
37
+ gem install ruby-vips
33
38
```
34
39
35
- or include it in ` Gemfile ` :
36
-
37
- ``` ruby
38
- gem " ruby-vips"
39
- ```
40
+ Or include ` gem "ruby-vips" ` in your gemfile.
40
41
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.
43
43
44
44
## Example
45
45
0 commit comments