redo README in markdown
This commit is contained in:
John Cupitt
parent
3694a2edc5
commit
726946c82d
157
README
157
README
@ -1,5 +1,4 @@
|
||||
libvips
|
||||
=======
|
||||
# libvips : an image processing library
|
||||
|
||||
libvips is an image processing library. It's good for large images and for
|
||||
colour. There's a GUI as well, see the VIPS website:
|
||||
@ -9,10 +8,9 @@ colour. There's a GUI as well, see the VIPS website:
|
||||
There are packages for most unix-like operating systems, and binaries for
|
||||
Windows and OS X.
|
||||
|
||||
Building libvips from source
|
||||
============================
|
||||
# Building libvips from source
|
||||
|
||||
In the libvips directory, you should just be able to do:
|
||||
In the libvips directory you should just be able to do:
|
||||
|
||||
$ ./configure
|
||||
$ make
|
||||
@ -20,20 +18,15 @@ In the libvips directory, you should just be able to do:
|
||||
|
||||
By default this will install files to /usr/local.
|
||||
|
||||
If you have problems, read on.
|
||||
See the Dependencies section below for a list of the things that
|
||||
libvips needs in order to be able to build.
|
||||
|
||||
Building libvips on win32
|
||||
-------------------------
|
||||
We have detailed guides on the wiki for [building on
|
||||
Windows](http://www.vips.ecs.soton.ac.uk/index.php?title=Build_on_windows)
|
||||
and [building on OS
|
||||
X](http://www.vips.ecs.soton.ac.uk/index.php?title=Build_on_OS_X).
|
||||
|
||||
http://www.vips.ecs.soton.ac.uk/index.php?title=Build_on_windows
|
||||
|
||||
Building libvips on OS X
|
||||
------------------------
|
||||
|
||||
http://www.vips.ecs.soton.ac.uk/index.php?title=Build_on_OS_X
|
||||
|
||||
Building libvips from GIT
|
||||
-------------------------
|
||||
# Building libvips from GIT
|
||||
|
||||
Checkout the latest sources with:
|
||||
|
||||
@ -46,16 +39,15 @@ Then for a debug build:
|
||||
$ make
|
||||
$ make install
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
# Dependencies
|
||||
|
||||
libvips has to have gettext, glib-2.x and libxml-2.0. The build system needs
|
||||
pkg-config and gnu make.
|
||||
sh, pkg-config and gnu make.
|
||||
|
||||
Optional dependencies
|
||||
---------------------
|
||||
# Optional dependencies
|
||||
|
||||
If suitable versions are found, libvips will add support for these
|
||||
If suitable versions are found, libvips will add support for the following
|
||||
libraries automatically. See "./configure --help" for a set of flags to
|
||||
control library detection. Packages are generally found with pkg-config,
|
||||
so make sure that is working.
|
||||
@ -79,77 +71,90 @@ or perhaps:
|
||||
|
||||
to get libvips to see your builds.
|
||||
|
||||
libjpeg
|
||||
The IJG JPEG library.
|
||||
## libjpeg
|
||||
|
||||
libexif
|
||||
if available, libvips adds support for EXIF metadata in JPEG files
|
||||
The IJG JPEG library.
|
||||
|
||||
libtiff
|
||||
The TIFF library. It needs to be built with support for JPEG and
|
||||
ZIP compression. 3.4b037 and later are known to be OK.
|
||||
## libexif
|
||||
|
||||
libz
|
||||
If your TIFF library includes ZIP compression, you'll need this too.
|
||||
if available, libvips adds support for EXIF metadata in JPEG files
|
||||
|
||||
videodev.h
|
||||
If libvips finds linux/videodev.h, you get support for Linux video
|
||||
grabbing.
|
||||
## libtiff
|
||||
|
||||
fftw3
|
||||
If libvips finds this library, it uses it for fourier transforms. It
|
||||
can also use fftw2, but 3 is faster and more accurate.
|
||||
The TIFF library. It needs to be built with support for JPEG and
|
||||
ZIP compression. 3.4b037 and later are known to be OK.
|
||||
|
||||
lcms2
|
||||
lcms
|
||||
If present, im_icc_import(), _export() and _transform() are available
|
||||
for transforming images with ICC profiles. If lcms2 is available,
|
||||
it is used in preference to lcms.
|
||||
## libz
|
||||
|
||||
large files
|
||||
libvips uses the standard autoconf tests to work out how to support
|
||||
large files (>2GB) on your system. Any reasonably recent *nix should
|
||||
be OK.
|
||||
If your TIFF library includes ZIP compression, you'll need this too.
|
||||
|
||||
libpng
|
||||
if present, libvips can load and save png files.
|
||||
## videodev.h
|
||||
|
||||
libMagick, or optionally GraphicsMagick
|
||||
if available, libvips adds support for loading all libMagick supported
|
||||
image file types (about 80 different formats). Use
|
||||
--with-magickpackage to build against graphicsmagick instead.
|
||||
If libvips finds linux/videodev.h, you get support for Linux video
|
||||
grabbing.
|
||||
|
||||
pangoft2
|
||||
if available, libvips adds support for text rendering. You need the
|
||||
package pangoft2 in "pkg-config --list-all"
|
||||
## fftw3
|
||||
|
||||
orc-0.4
|
||||
if available, vips will accelerate some operations with this run-time
|
||||
compiler
|
||||
If libvips finds this library, it uses it for fourier transforms. It
|
||||
can also use fftw2, but 3 is faster and more accurate.
|
||||
|
||||
matio
|
||||
if available, vips can load images from Matlab save files
|
||||
## lcms2, lcms
|
||||
|
||||
cfitsio
|
||||
if available, vips can load FITS images
|
||||
If present, im_icc_import(), _export() and _transform() are available
|
||||
for transforming images with ICC profiles. If lcms2 is available,
|
||||
it is used in preference to lcms.
|
||||
|
||||
OpenEXR
|
||||
if available, libvips will directly read (but not write, sadly)
|
||||
OpenEXR images
|
||||
## Large files
|
||||
|
||||
OpenSlide
|
||||
if available, libvips can load OpenSlide-supported virtual slide
|
||||
files: Aperio, Hamamatsu VMS and VMU, MIRAX, and Trestle
|
||||
libvips uses the standard autoconf tests to work out how to support
|
||||
large files (>2GB) on your system. Any reasonably recent *nix should
|
||||
be OK.
|
||||
|
||||
swig
|
||||
python
|
||||
python-dev
|
||||
if available, we build the python binding too
|
||||
## libpng
|
||||
|
||||
Disclaimer
|
||||
----------
|
||||
if present, libvips can load and save png files.
|
||||
|
||||
Disclaimer: No guarantees of performance accompany this software, nor is any
|
||||
## libMagick, or optionally GraphicsMagick
|
||||
|
||||
if available, libvips adds support for loading all libMagick supported
|
||||
image file types (about 80 different formats). Use
|
||||
--with-magickpackage to build against graphicsmagick instead.
|
||||
|
||||
## pangoft2
|
||||
|
||||
if available, libvips adds support for text rendering. You need the
|
||||
package pangoft2 in "pkg-config --list-all"
|
||||
|
||||
## orc-0.4
|
||||
|
||||
if available, vips will accelerate some operations with this run-time
|
||||
compiler
|
||||
|
||||
## matio
|
||||
|
||||
if available, vips can load images from Matlab save files
|
||||
|
||||
## cfitsio
|
||||
|
||||
if available, vips can load FITS images
|
||||
|
||||
## OpenEXR
|
||||
|
||||
if available, libvips will directly read (but not write, sadly)
|
||||
OpenEXR images
|
||||
|
||||
## OpenSlide
|
||||
|
||||
if available, libvips can load OpenSlide-supported virtual slide
|
||||
files: Aperio, Hamamatsu VMS and VMU, MIRAX, and Trestle
|
||||
|
||||
## swig, python, python-dev
|
||||
|
||||
if available, we build the python binding too
|
||||
|
||||
# Disclaimer
|
||||
|
||||
No guarantees of performance accompany this software, nor is any
|
||||
responsibility assumed on the part of the authors. Please read the licence
|
||||
agreement.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user