summaryrefslogtreecommitdiff
path: root/README.md
blob: 06dd567ea27e39e02b19399b746ad5ac7e4eadc3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
sent
====

A simple plaintext presentation tool.

sent does not need latex, libreoffice or any other fancy file format, it uses
plaintext files. 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.

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`.

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 ...]

If one FILE equals `-`, stdin will be read. A presentation file could look like
this:

	sent
	why?
	easy to use
	few dependencies (X11)
	no bloat
	how?
	sent FILENAME
	one slide per line
	thanks / questions?

future features
---------------

* utf8 support
* second window for speakers laptop (progress, time, notes?)
* images
* multiple lines per slide?
* markdown?