add a /docs folder

for github pages from master
This commit is contained in:
John Cupitt 2017-03-27 15:18:42 +01:00
parent 74892bd1e3
commit 63eab7c180
1 changed files with 148 additions and 0 deletions

148
docs/index.html Normal file
View File

@ -0,0 +1,148 @@
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/github-light.css" media="screen">
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print">
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<title>vips</title>
</head>
<body>
<header>
<div class="inner">
<h1>VIPS</h1>
<h2>A fast image processing library with low memory needs.</h2>
<a href="https://github.com/jcupitt/libvips" class="button"><small>View project on</small> GitHub</a>
</div>
</header>
<div id="content-wrapper">
<div class="inner clearfix">
<section id="main-content">
<h1>
<a id="libvips--an-image-processing-library" class="anchor" href="#libvips--an-image-processing-library" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>libvips : an image processing library</h1>
<p><a href="http://travis-ci.org/jcupitt/libvips"><img src="https://secure.travis-ci.org/jcupitt/libvips.png" alt="Build Status"></a>
<a href="https://scan.coverity.com/projects/jcupitt-libvips"><img src="https://scan.coverity.com/projects/6503/badge.svg" alt="Coverity Status"></a></p>
<p>libvips is a 2D image processing library. Compared to
similar libraries, <a href="http://www.vips.ecs.soton.ac.uk/index.php?title=Speed_and_Memory_Use">libvips runs quickly and uses little
memory</a>.
libvips is licensed under the LGPL 2.1+.</p>
<p>It has around 300 operations covering arithmetic, histograms,
convolutions, morphological operations, frequency filtering, colour,
resampling, statistics and others. It supports a large range of numeric
formats, from 8-bit int to 128-bit complex. It supports a good range of
image formats, including JPEG, TIFF, PNG, WebP, FITS, Matlab, OpenEXR,
PDF, SVG, HDR, PPM, CSV, GIF, Analyze, DeepZoom, and OpenSlide. It can
also load images via ImageMagick or GraphicsMagick.</p>
<p>It has APIs for
<a href="http://www.vips.ecs.soton.ac.uk/supported/current/doc/html/libvips/using-from-c.html">C</a>
and
<a href="http://www.vips.ecs.soton.ac.uk/supported/current/doc/html/libvips/using-from-cpp.html">C++</a>
and comes with a <a href="http://www.vips.ecs.soton.ac.uk/supported/current/doc/html/libvips/using-from-python.html">Python
binding</a>
and a <a href="http://www.vips.ecs.soton.ac.uk/supported/current/doc/html/libvips/using-cli.html">command-line
interface</a>.
Bindings are available for <a href="https://rubygems.org/gems/ruby-vips">Ruby</a>,
JavaScript and others. There is full
<a href="http://www.vips.ecs.soton.ac.uk/supported/current/doc/html/libvips/index.html">documentation</a>.
There are several GUIs as well, see the <a href="http://www.vips.ecs.soton.ac.uk">VIPS
website</a>.</p>
<p>There are packages for most unix-like operating systems and binaries for
Windows and OS X.</p>
<a id="building-libvips-from-a-source-tarball" class="anchor" href="#building-libvips-from-a-source-tarball" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Building libvips from a source tarball</h1>
<p>We keep pre-baked tarballs of releases on the vips website:</p>
<p><a href="http://www.vips.ecs.soton.ac.uk/supported/current/">http://www.vips.ecs.soton.ac.uk/supported/current/</a></p>
<p>Untar, then in the libvips directory you should just be able to do:</p>
<pre><code>$ ./configure
</code></pre>
<p>Check the summary at the end of <code>configure</code> carefully.
libvips must have <code>build-essential</code>, <code>pkg-config</code>, <code>glib2.0-dev</code>, and
<code>libxml2-dev</code>. </p>
<p>For the vips8 Python binding, you must have
<code>gobject-introspection</code>, <code>python-gi-dev</code>, and <code>libgirepository1.0-dev</code>.</p>
<p>You'll need the dev packages for the file format support you
want. For basic jpeg and tiff support, you'll need <code>libtiff5-dev</code>,
<code>libjpeg-turbo8-dev</code>, and <code>libgsf-1-dev</code>. See the <strong>Dependencies</strong> section
below for a full list of the things that libvips can be configured to use.</p>
<p>Once <code>configure</code> is looking OK, compile and install with the usual:</p>
<pre><code>$ make
$ sudo make install
</code></pre>
<p>By default this will install files to <code>/usr/local</code>.</p>
<p>We have detailed guides on the wiki for <a href="http://www.vips.ecs.soton.ac.uk/index.php?title=Build_on_windows">building on
Windows</a>
and <a href="http://www.vips.ecs.soton.ac.uk/index.php?title=Build_on_OS_X">building on OS
X</a>.</p>
<h1>
<a id="building-libvips-from-git" class="anchor" href="#building-libvips-from-git" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Building libvips from git</h1>
<p>Checkout the latest sources with:</p>
<pre><code>$ git clone git://github.com/jcupitt/libvips.git
</code></pre>
<p>Building from git needs more packages, you'll need at least <code>swig</code>, <code>gtk-doc</code>
and <code>gobject-introspection</code>, see the dependencies section below. For example:</p>
<pre><code>$ brew install gtk-doc swig
</code></pre>
<p>Then build the build system with:</p>
<pre><code>$ ./bootstrap.sh
</code></pre>
<h1>
<a id="disclaimer" class="anchor" href="#disclaimer" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Disclaimer</h1>
<p>No guarantees of performance accompany this software, nor is any
responsibility assumed on the part of the authors. Please read the licence
agreement.</p>
</section>
<aside id="sidebar">
<a href="https://github.com/jcupitt/libvips/zipball/master" class="button">
<small>Download</small>
.zip file
</a>
<a href="https://github.com/jcupitt/libvips/tarball/master" class="button">
<small>Download</small>
.tar.gz file
</a>
<p class="repo-owner"><a href="https://github.com/jcupitt/libvips"></a> is maintained by <a href="https://github.com/jcupitt">jcupitt</a>.</p>
<p>This page was generated by <a href="https://pages.github.com">GitHub Pages</a> using the Architect theme by <a href="https://twitter.com/jasonlong">Jason Long</a>.</p>
</aside>
</div>
</div>
</body>
</html>