update example
authorMarkus Teich <markus.teich@stusta.mhn.de>
Mon, 19 Jan 2015 17:39:04 +0000 (18:39 +0100)
committerMarkus Teich <markus.teich@stusta.mhn.de>
Mon, 19 Jan 2015 17:39:04 +0000 (18:39 +0100)
README.md
example

index b305fbe5a4abafe78652b5acb944e7a89d1f934a..9e5183d2a06a33aaaee3bb096863cee3994f4c42 100644 (file)
--- a/README.md
+++ b/README.md
@@ -44,7 +44,8 @@ Usage
        sent [-f FONTSTRING] FILE1 [FILE2 ...]
 
 If one FILE equals `-`, stdin will be read. Use png images by prepending a `@`
-before the filename. A presentation file could look like this:
+before the filename. Lines starting with `#` will be ignored. A presentation
+file could look like this:
 
        sent
        why?
@@ -55,6 +56,9 @@ before the filename. A presentation file could look like this:
        how?
        sent FILENAME
        one slide per line
+       # This is a comment and will not be part of the presentation
+       # The next line starts with a whitespace, it will not produce an image slide
+        @FILE.png
        thanks / questions?
 
 future features
diff --git a/example b/example
index 6aa415a39f5470786a2319cad638f9516227f8fe..6f6ec9a0857f76d922c69ef80e4662ba56511ed5 100644 (file)
--- a/example
+++ b/example
@@ -7,6 +7,7 @@ no bloat
 how?
 sent FILENAME
 one slide per line
-# comments
+# This is a comment and will not be part of the presentation
+# The next line starts with a whitespace, it will not produce an image slide
  @FILE.png
 thanks / questions?