File: README.rst

package info (click to toggle)
hovercraft 2.7-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 1,476 kB
  • sloc: javascript: 3,206; python: 2,606; makefile: 157; sh: 2
file content (50 lines) | stat: -rw-r--r-- 1,454 bytes parent folder | download
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
Hovercraft!
===========

*The merge of convenience and cool!*

Hovercraft! is a tool to make impress.js_ presentations from
reStructuredText. 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!

* Support for showing mathematical formulas.

* Styling is easy with CSS.

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

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

Hovercraft requires Python 3 and can be installed like any Python package.

The easiest way is to install pip_, and then run::

    $ pip3 install hovercraft

Juan Bondi has made videos of how to install:

* Installation on Ubuntu and Debian based computers: https://www.youtube.com/watch?v=tHSJLF9OnKQ

* Installation on Windows: https://www.youtube.com/watch?v=I63I8Az24d8

Hovercraft is untested on Windows, but there is no reason it shouldn't work, at least in theory.


.. _impress.js: http://github.com/bartaz/impress.js
.. _demo: http://regebro.github.com/hovercraft
.. _readthedocs.org: https://hovercraft.readthedocs.io/
.. _pip: http://www.pip-installer.org/en/latest/