sergiotarxz/libvips
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update README

Browse Source
This commit is contained in:
John Cupitt 2015-05-05 13:50:43 +01:00
parent 8ba680605a
commit bf316364c5
1 changed files with 30 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -29,14 +29,27 @@ Windows and OS X.
In the libvips directory you should just be able to do: In the libvips directory you should just be able to do:
$ ./configure $ ./configure
Check the summary at the end of `configure` carefully.
libvips must have `build-essential`, `pkg-config`, `glib2.0-dev`, and
`libxml2-dev`.
For the vips8 Python binding, you must have
`gobject-introspection`, `python-gi-dev`, and `libgirepository1.0-dev`.
You'll need the dev packages for the file format support you want. For basic
jpeg and tiff support, you'll need
`libtiff5-dev`, `libjpeg-turbo8-dev`, and `libgsf-1-dev`.
See the Dependencies section below for a full list of the things that
libvips can be configured to use.
Once `configure` is looking OK, compile and install with the usual:
$ make $ make
$ sudo make install $ sudo make install
By default this will install files to `/usr/local`. By default this will install files to `/usr/local`.
See the Dependencies section below for a list of the things that
libvips needs in order to be able to build.
We have detailed guides on the wiki for [building on We have detailed guides on the wiki for [building on
Windows](http://www.vips.ecs.soton.ac.uk/index.php?title=Build_on_windows) Windows](http://www.vips.ecs.soton.ac.uk/index.php?title=Build_on_windows)
and [building on OS and [building on OS
@ -48,8 +61,8 @@ Checkout the latest sources with:
$ git clone git://github.com/jcupitt/libvips.git $ git clone git://github.com/jcupitt/libvips.git
Building from git needs more packages. You'll need at least swig, gtk-doc and Building from git needs more packages, you'll need at least `swig`, `gtk-doc`
gobject-introspection, see the dependencies section below. For example: and `gobject-introspection`, see the dependencies section below. For example:
$ brew install gtk-doc swig $ brew install gtk-doc swig
@ -116,9 +129,8 @@ Static analysis with:
# Dependencies # Dependencies
libvips has to have gettext, glib-2.0 and libxml-2.0. The build system libvips has to have `gettext`, `glib2.0-dev` and `libxml2-dev`. Other
needs sh, pkg-config, swig, gtk-doc-tools, autoconf, gobject-introspection dependencies are optional, see below.
and gnu make.
# Optional dependencies # Optional dependencies
@ -146,6 +158,11 @@ or perhaps:
to get libvips to see your builds. to get libvips to see your builds.
## vips8 Python binding
If `gobject-introspection`, `python-gi-dev`, and `libgirepository1.0-dev` are
available, libvips will install the vips8 Python binding.
## libjpeg ## libjpeg
The IJG JPEG library. The IJG JPEG library.
@ -170,14 +187,14 @@ can also use fftw2, but 3 is faster and more accurate.
## lcms2, lcms ## lcms2, lcms
If present, im_icc_import(), _export() and _transform() are available If present, vips_icc_import(), vips_icc_export() and vips_icc_transform() are
for transforming images with ICC profiles. If lcms2 is available, available for transforming images with ICC profiles. If lcms2 is available,
it is used in preference to lcms since it is faster. it is used in preference to lcms, since it is faster.
## Large files ## Large files
libvips uses the standard autoconf tests to work out how to support libvips uses the standard autoconf tests to work out how to support
large files (>2GB) on your system. Any reasonably recent *nix should large files (>2GB) on your system. Any reasonably recent unix should
be OK. be OK.
## libpng ## libpng
@ -224,7 +241,7 @@ files: Aperio, Hamamatsu, Leica, MIRAX, Sakura, Trestle, and Ventana.
## swig, python, python-dev ## swig, python, python-dev
If available, we build the python binding too. If available, we build the vips7 python binding.
# Disclaimer # Disclaimer