summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst63
1 files changed, 63 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..ddc18d4
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,63 @@
1Presentty
2=========
3
4Presentty is a console-based presentation program based on
5RestructuredText.
6
7Installation
8------------
9
10It is recommended, but not required, to install presentty in to a
11virtualenv. To cset one up::
12
13 virtualenv presentty-env
14 source presentty-env/bin/activate
15
16To install the latest version from the cheeseshop::
17
18 pip install presentty
19
20To install from a git checkout::
21
22 pip install .
23
24In order to use the cross-fade transition, you must run presentty in a
25256-color capable terminal, such as gnome-terminal or xterm.
26
27In order for images to render as ascii art, you must have jp2a
28installed.
29
30In order to use figlet and cowsay directives, their respective
31programs must be installed.
32
33Usage
34-----
35
36Presentty takes the path to the presentation file as an argument.
37
38To run the demonstration included with Presentty, run the following::
39
40 presentty example/demo.rst
41
42Other command line options are available; you can see them with::
43
44 presentty --help
45
46Once presentty is running, you may start an optional presenter's
47console in another window with::
48
49 presentty-console example/demo.rst
50
51Once in the presenter's console, you can use the arrow keys and
52[enter] to change the current slide, 't' to set the countdown timer
53starting value, and [space] to start or stop the timer.
54
55In either the presenter's console or the main presentty window, the
56left and right arrow keys or page-up and page-down navigate between
57slides.
58
59License
60-------
61
62Presentty is licensed under the GPLv3 or later. Please see the
63COPYING file for details.