aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Phillips <dbphillipsnz@gmail.com>2016-05-03 12:34:27 +1200
committerDavid Phillips <dbphillipsnz@gmail.com>2016-05-03 12:34:27 +1200
commit6bcb11cdb5aeb75cd43a97a3708aa93ced1d76c2 (patch)
tree806f88105e0863fa4d0f4b4b29db16c3d91345e3
parent787ae3671d9a85dd999ea35b19d9eb82572f8946 (diff)
downloadpgm-interlace-6bcb11cdb5aeb75cd43a97a3708aa93ced1d76c2.tar.xz
Add diagram to readme
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
index 815a201..58b0ab2 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,32 @@
# pgm-interlace
Vertically interlace *n* PGM frames, each one *height/n* pixels in width into
one square image with a width the same as the height.
+
+By example, it would take two 2x4 images:
+
+ Image A:
+ 0 1
+ 1 A B
+ 2 C D
+ 3 E F
+ 4 G H
+
+ Image B:
+ 0 1
+ 1 I J
+ 2 K L
+ 3 M N
+ 4 O P
+
+combining them into one single 4x4 image from the command `pgm-interlace imageA imageB`
+
+ 0 1 2 3
+ 0 A I B J
+ 1 C K D L
+ 2 E M F N
+ 3 G O H P
+
+The order in which the frames are specified on the command line is critical for
+the reconstruction of the image. pgm-interlace has no way of telling in which
+order a handful of pgm frames should be interlaced unless you tell it how to
+stitch them together.