README

   1                         ImageCap
   2                         ========
   3
   4 What is ImageCap?
   5 -----------------
   6
   7 IMageCap is a shell script for adding captins to image files. It reads and
   8 writes captins to images by using exif data format.
   9
  10 ImageCap is written in bash script.
  11
  12 Downloading
  13 -----------
  14
  15 Latest release of ImageCap can be downloaded from http://code.agnibho.com/imagecap/
  16
  17 Dependencies
  18 ------------
  19
  20 ImageCap depends on: bash, coreutils, sed, exiftool, feh, xdg-open.
  21
  22 Installation
  23 ------------
  24
  25 Download the script and place it in your path. Alternatively you can place it
  26 anywhere and create an alias instead.
  27
  28 Usage
  29 -----
  30
  31 ImageCap can be used from bash command line.
  32
  33 Run imagecap with the image file name as the argument to view / add /edit
  34 captions.
  35
  36     imagecap <filename>
  37
  38 After opening the image file you can add or edit the caption by pressing <1>
  39 key. The caption will open in an editor where you can modify it. After saving
  40 the editor content the caption will be automatically updated.
  41
  42 ImageCap uses feh as the image viewer, exiftools as the caption manager and gvim
  43 as the editor. You can use other editors by modifying the EDIT variable in the
  44 script.
  45
  46 Licensing
  47 ---------
  48
  49 Copyright (c) 2017 Agnibho Mondal
  50 All rights reserved
  51
  52 This file is part of ImageCap.
  53
  54 ImageCap is free software: you can redistribute it and/or modify it under the
  55 terms of the GNU General Public License as published by the Free Software
  56 Foundation, either version 3 of the License, or (at your option) any later
  57 version.
  58
  59 ImageCap is distributed in the hope that it will be useful, but WITHOUT ANY
  60 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
  61 PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  62
  63 You should have received a copy of the GNU General Public License along with
  64 ImageCap.  If not, see <http://www.gnu.org/licenses/>.
  65
  66 Contacts
  67 --------
  68
  69 Agnibho Mondal
  70 contact@agnibho.com
  71 www.agnibho.com