summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorStijn Buys <ingar@telenet.be>2022-05-25 20:30:47 +0200
committerStijn Buys <ingar@telenet.be>2022-05-25 20:30:47 +0200
commit964550b800e3f4028a96bb75695c792afa9ee069 (patch)
treecc06aa479bf0f72cd716eb78f99400e8426377da /README
parent518a8db167fd3b1d94ccee76806847c097e82620 (diff)
Updated documentation.
Diffstat (limited to 'README')
-rw-r--r--README15
1 files changed, 9 insertions, 6 deletions
diff --git a/README b/README
index 5011153..69ae101 100644
--- a/README
+++ b/README
@@ -1,18 +1,18 @@
GENCLOCKIMG
- genclockimg is a small program to generate clock face PNG images.
+ 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 cairo and libpopt. These are fairly common
- and chances are high you already have this installed on your system.
+ 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 rahra's cairo_jpg library to handle JPEG images.
+ 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 libcairo and libpopt and
+ To build genclockimg you need libjpeg, libcairo, libpopt and
their accompanying dev packages installed. You'll also need
a C compiler and GNU Make.
@@ -46,6 +46,9 @@ OPTIONS
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
@@ -60,7 +63,7 @@ EXAMPLES
Generate a series of clock images based on the timestamps of a series of source images:
- for file in *.jpg; do genclockimg -t `date -r "${file}" +"%H:%M"` -o "${file}-clock.png"; done
+ for file in *.jpg; do genclockimg -j -t `date -r "${file}" +"%H:%M"` -o "clock-${file}"; done
LICENSE