summaryrefslogtreecommitdiff
path: root/README.rst
blob: 9270b08acb509238f209e45f625e0f7066069aec (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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
Presentty
=========

Presentty is a console-based presentation program based on
RestructuredText.

Installation
------------

It is recommended, but not required, to install presentty in to a
virtualenv.  To set one up::

  virtualenv presentty-env
  source presentty-env/bin/activate

To install the latest version from the cheeseshop::

  pip install presentty

To install from a git checkout::

  pip install .

In order to use the cross-fade transition, you must run presentty in a
256-color capable terminal, such as gnome-terminal or xterm.

In order for images to render as ascii art, you must have jp2a
installed.

In order to use figlet and cowsay directives, their respective
programs must be installed.

Usage
-----

Presentty takes the path to the presentation file as an argument.

To run the demonstration included with Presentty, run the following::

  presentty example/demo.rst

Other command line options are available; you can see them with::

  presentty --help

Once presentty is running, you may start an optional presenter's
console in another window with::

  presentty-console example/demo.rst

Once in the presenter's console, you can use the arrow keys and
[enter] to change the current slide, 't' to set the countdown timer
starting value, and [space] to start or stop the timer.

In either the presenter's console or the main presentty window, the
left and right arrow keys or page-up and page-down navigate between
slides.

To exit presentty gracefully, use the 'q' key.

Source
------

Git repo: http://git.inaugust.com/cgit/presentty/

Contributing
------------

To send your latest commit as a patch, run::

  git send-email --to corvus@gnu.org --annotate -1

License
-------

Presentty is licensed under the GPLv3 or later.  Please see the
COPYING file for details.