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

   1 # README file for PEL Examples
   2
   3 ## PEL Examples
   4
   5 This directory contains various examples of how PEL can be used in
   6 small scripts.  The scripts are meant to be executed from the command
   7 line and they assume that you have PHP installed as /usr/bin/php.  If
   8 that is not the case, then please adjust the first line before
   9 executing the scripts, or simply execute them as
  10
  11 ```
  12 % php <script> <arguments>
  13 ```
  14
  15 and let your shell find the PHP executable.
  16
  17 The examples are:
  18
  19 * dirsort.php: an example of how to use PEL to automatically sort a
  20   collection of photos into different folders.
  21
  22   The script accepts a number of filenames on the command line, and
  23   will move them to folders based on the month the photo was taken.
  24
  25 * dump-image.php: a simple script that will load an image and show the
  26   structure.
  27
  28   A JPEG or TIFF image should be specified on the command line.  The
  29   dump will give detailed information about the structure in the
  30   image.
  31
  32 * edit-description.php: a big example showing how to update the
  33   ImageDescription Exif tag using PEL.
  34
  35   The script is heavely commented, and should be used as a good
  36   reference as to how PEL works and how it should be used.
  37
  38 * gps.php: shows how to add GPS information to an image using PEL.
  39
  40 * rename.php: a script similar to dirsort.php, only that this one will
  41   rename photos to a filename containing the full date and time taken
  42   from the DateTime Exif tag.
  43
  44 * resize.php: a script to resize images.
  45
  46
  47 ## Contributing New Examples
  48
  49 More examples are needed!  If you have a neat example of how PEL can
  50 be used, then please contribute it to PEL.  Please submit it as a new
  51 item in the Github issue tracker:
  52
  53   http://github.com/lsolesen/pel/issues
  54
  55 Or issue a pull request. It will then be included in the next release
  56 of PEL, of course with full credit in the AUTHORS file.