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, zenity.
  21
  22 Installation
  23 ------------
  24
  25 Make sure you have all the dependencies installed in your system.
  26
  27 Run 'make install' to install the program to your system. You may need to be
  28 superuser to do this. If you wish to uninstall the program you can do so by
  29 running 'make uninstall'.
  30
  31 Usage
  32 -----
  33
  34 ImageCap can be used from bash command line.
  35
  36 Run imagecap with the image file name as the argument to view / add /edit
  37 captions.
  38
  39     imagecap <filename>
  40
  41 After opening the image file you can add or edit the caption by pressing <1>
  42 key. The caption will open in an editor where you can modify it. After saving
  43 the editor content the caption will be automatically updated.
  44
  45 ImageCap uses feh as the image viewer, exiftools as the caption manager and gvim
  46 as the editor. You can use other editors by modifying the EDIT variable in the
  47 script.
  48
  49 Licensing
  50 ---------
  51
  52 Copyright (c) 2017 Agnibho Mondal
  53 All rights reserved
  54
  55 This file is part of ImageCap.
  56
  57 ImageCap is free software: you can redistribute it and/or modify it under the
  58 terms of the GNU General Public License as published by the Free Software
  59 Foundation, either version 3 of the License, or (at your option) any later
  60 version.
  61
  62 ImageCap is distributed in the hope that it will be useful, but WITHOUT ANY
  63 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
  64 PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  65
  66 You should have received a copy of the GNU General Public License along with
  67 ImageCap.  If not, see <http://www.gnu.org/licenses/>.
  68
  69 Contacts
  70 --------
  71
  72 Agnibho Mondal
  73 contact@agnibho.com
  74 www.agnibho.com