phundrak/sent
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Markus Teich 2015-11-17 00:32:45 +01:00
parent b1cb3bbc20
commit aa713a8a34
1 changed files with 27 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
README.md
View File

@ -1,70 +1,50 @@
sent sent is a simple plaintext presentation tool.
====
A simple plaintext presentation tool.
sent does not need latex, libreoffice or any other fancy file format, it uses 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 plaintext files and png images. Every paragraph represents a slide in the
presentation. This may limit the use, but for presentations using the [Takahashi presentation.
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 The presentation is displayed in a simple X11 window. The content of each slide
few minutes. 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 Demo
----
To get a little demo, just type To get a little demo, just type
make && ./sent example make && ./sent example
You can navigate with the arrow keys and quit with `q`. If you get You can navigate with the arrow keys and quit with `q`.
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:
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 Usage
-----
sent [-f FONTSTRING] FILE1 [FILE2 ...] sent FILE1 [FILE2 ...]
If one FILE equals `-`, stdin will be read. Use png images by prepending a `@` If one FILE equals `-`, stdin will be read. Produce image slides by prepending a
before the filename. Lines starting with `#` will be ignored. A presentation `@` in front of the filename as a single paragraph. Lines starting with `#` will
file could look like this: be ignored. A `\` at the beginning of the line escapes `@` and `#`. A
presentation file could look like this:
sent sent
why?
@nyan.png @nyan.png
easy to use
depends on Xlib, libpng depends on
no bloat - Xlib
how? - libpng
sent FILENAME sent FILENAME
one slide per line one slide per paragraph
# This is a comment and will not be part of the presentation # 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 \# This and the next line start with backslashes
@FILE.png
\@FILE.png
thanks / questions? thanks / questions?
future features
---------------
* multiple lines per slide? Development
* light colored background and table of contents
* second window for speakers laptop (progress, time, notes?) sent is developed at http://tools.suckless.org/sent
* markdown?