README.md
1sent is a simple plaintext presentation tool.
2
3sent does not need latex, libreoffice or any other fancy file format, it uses
4plaintext files to describe the slides and can include images via farbfeld.
5Every paragraph represents a slide in the presentation.
6
7The presentation is displayed in a simple X11 window. The content of each slide
8is automatically scaled to fit the window and centered so you also don't have to
9worry about alignment. Instead you can really concentrate on the content.
10
11
12Dependencies
13
14You need Xlib and Xft to build sent and the farbfeld[0] tools installed to use
15images in your presentations.
16
17Demo
18
19To get a little demo, just type
20
21 make && ./sent example
22
23You can navigate with the arrow keys and quit with `q`.
24
25
26Usage
27
28 sent [FILE]
29
30If FILE is omitted or equals `-`, stdin will be read. Produce image slides by
31prepending a `@` in front of the filename as a single paragraph. Lines starting
32with `#` will be ignored. A `\` at the beginning of the line escapes `@` and
33`#`. A presentation file could look like this:
34
35 sent
36
37 @nyan.png
38
39 depends on
40 - Xlib
41 - Xft
42 - farbfeld
43
44 sent FILENAME
45 one slide per paragraph
46 # This is a comment and will not be part of the presentation
47 \# This and the next line start with backslashes
48
49 \@FILE.png
50
51 thanks / questions?
52
53
54Development
55
56sent is developed at http://tools.suckless.org/sent
57
58
590: http://tools.suckless.org/farbfeld/
60