commit aa713a8a342ec0e6eca173cd4489834f8baa0a86
parent b1cb3bbc2085bc30e0a456d02e7eb68d5665a5b2
Author: Markus Teich <markus.teich@stusta.mhn.de>
Date: Tue, 17 Nov 2015 00:32:45 +0100
update README
Diffstat:
| M | README.md | | | 74 | +++++++++++++++++++++++++++----------------------------------------------- |
1 file changed, 27 insertions(+), 47 deletions(-)
diff --git a/README.md b/README.md
@@ -1,70 +1,50 @@
-sent
-====
-
-A simple plaintext presentation tool.
+sent is a simple plaintext presentation tool.
sent does not need latex, libreoffice or any other fancy file format, it uses
-plaintext files and png images. Every line represents a slide in the
-presentation. This may limit the use, but for presentations using the [Takahashi
-method](https://en.wikipedia.org/wiki/Takahashi_method) this is very nice and
-allows you to write down the presentation for a quick lightning talk within a
-few minutes.
+plaintext files and png images. Every paragraph represents a slide in the
+presentation.
+
+The presentation is displayed in a simple X11 window. The content of each slide
+is automatically scaled to fit the window and centered so you also don't have to
+worry about alignment. Instead you can really concentrate on the content.
-The presentation is displayed in a simple X11 window colored black on white for
-maximum contrast even if the sun shines directly onto the projected image. The
-content of each slide is automatically scaled to fit the window so you don't
-have to worry about alignment. Instead you can really concentrate on the
-content.
Demo
-----
To get a little demo, just type
make && ./sent example
-You can navigate with the arrow keys and quit with `q`. If you get
-
- sent: could not find a scalable font matching -*-dejavu sans condensed-bold-r-*-*-0-0-*-*-*-0-*-*
-
-you should add the dejavu fonts dir (customize path to fit your distribution)
-with:
+You can navigate with the arrow keys and quit with `q`.
- xset fp+ /usr/share/fonts/dejavu
-
-Configuration
--------------
-
-Edit config.h to fit your needs. The font has to be in the X servers font path,
-see `man xset` for how to add it.
Usage
------
- sent [-f FONTSTRING] FILE1 [FILE2 ...]
+ sent FILE1 [FILE2 ...]
-If one FILE equals `-`, stdin will be read. Use png images by prepending a `@`
-before the filename. Lines starting with `#` will be ignored. A presentation
-file could look like this:
+If one FILE equals `-`, stdin will be read. Produce image slides by prepending a
+`@` in front of the filename as a single paragraph. Lines starting with `#` will
+be ignored. A `\` at the beginning of the line escapes `@` and `#`. A
+presentation file could look like this:
sent
- why?
+
@nyan.png
- easy to use
- depends on Xlib, libpng
- no bloat
- how?
+
+ depends on
+ - Xlib
+ - libpng
+
sent FILENAME
- one slide per line
+ one slide per paragraph
# 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
+ \# This and the next line start with backslashes
+
+ \@FILE.png
+
thanks / questions?
-future features
----------------
-* multiple lines per slide?
-* light colored background and table of contents
-* second window for speakers laptop (progress, time, notes?)
-* markdown?
+Development
+
+sent is developed at http://tools.suckless.org/sent
