sent/README.md

60 lines
1.4 KiB
Markdown
Raw Normal View History

2015-11-17 00:32:45 +01:00
sent is a simple plaintext presentation tool.
2014-06-23 00:53:45 +02:00
sent does not need latex, libreoffice or any other fancy file format, it uses
2015-12-08 22:09:26 +01:00
plaintext files to describe the slides and can include images via farbfeld.
Every paragraph represents a slide in the presentation.
2015-11-17 00:32:45 +01:00
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.
2014-06-23 00:53:45 +02:00
2015-12-08 22:09:26 +01:00
Dependencies
2016-10-09 15:27:02 +02:00
You need Xlib and Xft to build sent and the farbfeld[0] tools installed to use
images in your presentations.
2015-12-08 22:09:26 +01:00
2014-06-23 11:31:17 +02:00
Demo
To get a little demo, just type
make && ./sent example
2015-11-17 00:32:45 +01:00
You can navigate with the arrow keys and quit with `q`.
2014-06-23 00:53:45 +02:00
Usage
sent [FILE]
2014-06-23 00:53:45 +02:00
If FILE is omitted or 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:
2014-06-23 00:53:45 +02:00
sent
2015-11-17 00:32:45 +01:00
2014-06-29 23:48:49 +02:00
@nyan.png
2015-11-17 00:32:45 +01:00
depends on
- Xlib
2016-10-09 15:27:02 +02:00
- Xft
- farbfeld
2015-11-17 00:32:45 +01:00
2014-06-23 00:53:45 +02:00
sent FILENAME
2015-11-17 00:32:45 +01:00
one slide per paragraph
2015-01-19 18:39:04 +01:00
# This is a comment and will not be part of the presentation
2015-11-17 00:32:45 +01:00
\# This and the next line start with backslashes
\@FILE.png
2014-06-23 00:53:45 +02:00
thanks / questions?
2015-11-17 00:32:45 +01:00
Development
sent is developed at http://tools.suckless.org/sent
2015-12-08 22:09:26 +01:00
2016-02-05 15:25:29 +01:00
0: http://tools.suckless.org/farbfeld/