forked from regebro/hovercraft
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.t2t
executable file
·79 lines (37 loc) · 2.05 KB
/
readme.t2t
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
Hovercraft-t2t
%!target: rst
**The merge of convenience and cool!**
Hovercraft-t2t is a tool to make impress.js_ presentations from
txt2tags. For a quick explanation, see the demo_.
== Features ==
- Write your presentations in a text markup language. No slow, limiting GUI, no annoying HTML!
- Pan, rotate and zoom in 3D, with automatic repositioning of slides!
- A presenter console with notes and slide previews!
- The slide show generated is in HTML, so you only need a web browser to show it.
- Easy sharing, as it can be put up on a website for anyone to see!
% Full documentation is available at readthedocs.org_, and also in the documentation subdirectory.
== Limitations ==
- presentations can only use moving slides. No "dissolve" effect yet.
- can't display bullets in lists one by one, like in traditional presentations.
- unlike reveal.js, doesn't seem to display well on smartphones or tablets.
== Installation ==
Hovercraft_ requires Python 3.2 or later, and can be installed like any Python package. Txt2tags_ requires Python 2.6
The easiest way is to install pip_, and then run:
``` pip install hovercraft
Hovercraft is untested on Windows, but there is no reason it shouldn't work, at least in theory.
== Contributors ==
The original Hovercraft_! was written by Lennart Regebro <[email protected]>, and is licensed as CC-0, except for the following:
- ``reST.xsl`` is (c) Michael Alyn Miller <[email protected]> and
published under a BSD-style license included in reST.xsl itself.
- ``impress.js`` is (c) Bartek Szopka (@bartaz) released under MIT and GPL
licenses. See the impress.js_ page for more information.
Other contributors:
- Carl Meyer (carljm)
- Chris Withers (cjw296)
- Eric Forgeot : hovercraft + txt2tags
.. _impress.js: http://github.com/bartaz/impress.js
.. _demo: http://farvardin.github.io/hovercraft-t2t/sample
.. _readthedocs.org: https://hovercraft.readthedocs.org/
.. _pip: http://www.pip-installer.org/en/latest/
.. _hovercraft: http://github.com/regebro/hovercraft
.. _txt2tags: http://www.txt2tags.org