8000 add a link to the backup docs · libvips/ruby-vips@e85ea1c · GitHub
[go: up one dir, main page]

Skip to content

Commit e85ea1c

Browse files
committed
add a link to the backup docs
in case rubydoc isn't working, see #316
1 parent 053987b commit e85ea1c

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -68,16 +68,21 @@ im = im.conv mask, precision: :integer
6868
im.write_to_file output_filename
6969
```
7070

71-
The `Vips` section in the API docs has a [tutorial introduction with
71+
# Documentation
72+
73+
There are [full API docs for ruby-vips on
74+
rubydoc](https://www.rubydoc.info/gems/ruby-vips). This sometimes has issues
75+
updating, so we have a [copy on the gh-pages for this site as
76+
well](http://libvips.github.io/ruby-vips), which
77+
should always work.
78+
79+
See the `Vips` section in the docs for a [tutorial introduction with
7280
examples](https://www.rubydoc.info/gems/ruby-vips/Vips).
7381

74-
ruby-vips has [API
75-
documentation](http://www.rubydoc.info/gems/ruby-vips). The [libvips
76-
reference manual](https://libvips.github.io/libvips/API/current/) has a
77-
complete explanation of every method.
82+
The [libvips reference manual](https://libvips.github.io/libvips/API/current/)
83+
has a complete explanation of every method.
7884

79-
The
80-
[`example/`](https://github.com/libvips/ruby-vips/tree/master/example)
85+
The [`example/`](https://github.com/libvips/ruby-vips/tree/master/example)
8186
directory has some simple example programs.
8287

8388
# Benchmarks

0 commit comments

Comments
 (0)
0