www.aleph1.co.uk Git - yaffs-website/blob - vendor/lsolesen/pel/README.markdown

   1 # PEL: PHP Exif Library
   2
   3 [![Build Status](https://secure.travis-ci.org/lsolesen/pel.png?branch=master)](http://travis-ci.org/lsolesen/pel) [![Code Coverage](https://scrutinizer-ci.com/g/lsolesen/pel/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/lsolesen/pel/?branch=master) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/lsolesen/pel/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/lsolesen/pel/?branch=master) [![Latest Stable Version](https://poser.pugx.org/lsolesen/pel/v/stable)](https://packagist.org/packages/lsolesen/pel) [![Total Downloads](https://poser.pugx.org/lsolesen/pel/downloads)](https://packagist.org/packages/lsolesen/pel) [![License](https://poser.pugx.org/lsolesen/pel/license)](https://packagist.org/packages/lsolesen/pel)
   4
   5 README file for PEL: PHP Exif Library.  A library with support for
   6 reading and writing Exif headers in JPEG and TIFF images using PHP.
   7
   8 Copyright (C) 2004, 2005, 2006  Martin Geisler.
   9 Licensed under the GNU GPL, see COPYING for details.
  10
  11
  12 ## Description
  13
  14 The PHP Exif Library (PEL) makes it easy to develop programs that will
  15 read and write the Exif metadata headers found in JPEG and TIFF
  16 images.  See the file INSTALL for an introduction to how PEL can be
  17 used by your application.
  18
  19 PEL is a library written entirely in PHP 5, which means that it does
  20 not have any dependencies outside the core of PHP, it does not even
  21 use the Exif module available for PHP.
  22
  23 Please note that the API for PEL is not yet frozen, and it will remain
  24 changeable until version 1.0 is reached. Read the NEWS file for
  25 important information about API changes.
  26
  27 Also, please go to the PEL development mailing list (look below) and
  28 share your ideas about how the API should look like.
  29
  30
  31 ## Documentation Overview
  32
  33 * README.markdown: gives you a short introduction to PEL (this file).
  34 * INSTALL.md: explain how to install and get going with PEL.
  35 * CHANGELOG.md: contains important information about changes in PEL.
  36 * examples/: small self-contained examples of how to use PEL.
  37 * AUTHORS: list of people who have helped.
  38 * run run-phpdoc.sh to generate API-documention or see it online at http://lsolesen.github.com/pel
  39
  40
  41 ## Features of PEL
  42
  43 * Reads and writes Exif metadata from both JPEG and TIFF images.
  44 * Supports reading and writing all Exif tags.
  45 * Supports internationalization.
  46 * Extensible object-oriented design.
  47 * PhpUnit tested
  48 * Documented with PhpDocumentor (http://phpdoc.org/).
  49
  50
  51 ## Helping out
  52
  53 Help will be very much appreciated. You can report issues, run the test
  54 suite, add patches. The best way to help out is applying patches and
  55 helping out with the tests. See instructions in the test/ directory.
  56
  57 All changes to code should be issued through a pull request, and other
  58 maintainers should review the code and merge it.
  59
  60
  61 ## Languages
  62
  63 To work with the translations, you need the gettext package installed.
  64
  65
  66 ## Getting Support
  67
  68 The first place you should consult for support is the documentation
  69 supplied with PEL, found in the doc/ directory.  There you will find a
  70 complete API documentation with descriptions of all classes and files
  71 in PEL.
  72
  73 The scripts found in the examples/ directory are also a good source of
  74 information, especially the edit-description.php file which has tons
  75 of comments.
  76
  77 PEL is hosted on Github and uses the tools found there for
  78 support.  This means that all questions, bug reports, etc. should be
  79 directed there (and not directly to the developers).
  80
  81 Please try the latest version before reporting bugs -- it might have
  82 been fixed already.  The latest code can be found in the git
  83 repository at
  84
  85   http://github.com/lsolesen/pel
  86
  87 It is very helpful if you try out the latest code from the git
  88 repository before submitting a bug report. The code found there is
  89 generally very stable.
  90
  91
  92 ## Contributing Test Images
  93
  94 To make PEL as stable as possible, it is tested with images from a
  95 number of different camera models.
  96
  97 New test images are very much appreciated -- please download the
  98 existing test images and read the README file found there for
  99 instructions.
 100
 101
 102 ## Credits
 103
 104 Please see the AUTHORS file for a list of people who have contributed
 105 to PEL. See the full list of [code contributors](https://github.com/lsolesen/pel/graphs/contributors).