summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README79
1 files changed, 0 insertions, 79 deletions
diff --git a/README b/README
deleted file mode 100644
index 69ae101..0000000
--- a/README
+++ /dev/null
@@ -1,79 +0,0 @@
-
-GENCLOCKIMG
-
- genclockimg is a small program to generate clock face images.
- I made it to generate a time index watermark for my timelapse videos.
-
- It is written in C and uses libjpeg, cairo and libpopt. These are fairly common
- and chances are high you already have these installed on your system.
-
- I used Bernhard R. Fischer cairo_jpg library to handle JPEG images.
- See https://github.com/rahra/cairo_jpg
-
-BUILDING
-
- To build genclockimg you need libjpeg, libcairo, libpopt and
- their accompanying dev packages installed. You'll also need
- a C compiler and GNU Make.
-
- To build the program:
-
- make
-
- To test:
-
- ./genclockimg
-
- A file 'out.png' should appear.
-
- To install:
-
- make install
-
- To uninstall:
-
- make uninstall
-
-RUNNING
-
- By default, running the program will create a 128x128 PNG image called 'out.png'
- in the current directory. The image will contain a simple analog clock indicating
- the current time.
-
-OPTIONS
-
- -o filename
- Output filename. The .png extension is NOT added automaticly!
- The output is always PNG, even if you name the file differently.
-
- -j
- Write a JPEG file instead of PNG.
-
- -t HH:MM
- Time to show on the clock
-
- -w width
- Width of the clock image in pixels
-
- -h height
- Height of the clock image in pixels
-
-
-EXAMPLES
-
- Generate a series of clock images based on the timestamps of a series of source images:
-
- for file in *.jpg; do genclockimg -j -t `date -r "${file}" +"%H:%M"` -o "clock-${file}"; done
-
-LICENSE
-
- genclockimg is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser
- General Public License as published by the Free Software Foundation, either version 3 of the License,
- or (at your option) any later version.
-
- genclockimg is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
-
- You should have received a copy of the GNU General Public License along with genclockimg.
- If not, see https://www.gnu.org/licenses/.
-
- Copyright (c) 2022, Stijn Buys