aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Phillips <dbphillipsnz@gmail.com>2016-05-10 23:37:06 +1200
committerDavid Phillips <dbphillipsnz@gmail.com>2016-05-10 23:37:06 +1200
commit9cd48e7e2e38704e5ec999b055948b0b28b976bc (patch)
tree2931bb11e17e2421a007f7d42b685d718fb64102
parent6daa87961ed8035085d11300073ee183b8db8391 (diff)
downloadpgm-interlace-9cd48e7e2e38704e5ec999b055948b0b28b976bc.tar.xz
Add synatx to readme, correct wording
-rw-r--r--README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/README.md b/README.md
index 2240874..17351e7 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,10 @@
# 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.
+Vertically interlace *n* PGM frames, each one *width/n* pixels in height into
+one square image.
+
+## Syntax
+
+ pgm-interlace [frame 0] [frame 1] [frame 2] ...
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