Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add readthedocs link #25

Merged
merged 4 commits into from
Oct 30, 2017
Merged

add readthedocs link #25

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ec2cfbc
add readthedocs link
thijstriemstra Oct 30, 2017
ca6c3cd
add introduction text
thijstriemstra Oct 30, 2017
6a272d3
link to examples
thijstriemstra Oct 30, 2017
edf5637
readthedocs do not pip install
thijstriemstra Oct 30, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
add introduction text
  • Loading branch information
@thijstriemstra
thijstriemstra authored Oct 30, 2017
commit ca6c3cdaf386b3722ccc985fb6e0027d9f9409fc
19 changes: 19 additions & 0 deletions doc/intro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,23 @@
Introduction
------------

There are various display emulators available for running code against, for debugging
and screen capture functionality:

* The :py:class:`luma.emulator.device.capture` device will persist a numbered PNG file to
disk every time its ``display`` method is called.

* The :py:class:`luma.emulator.device.gifanim` device will record every image when its ``display``
method is called, and on program exit (or Ctrl-C), will assemble the images into an
animated GIF.

* The :py:class:`luma.emulator.device.pygame` device uses the `pygame` library to
render the displayed image to a pygame display surface.

Invoke the demos with::

$ python examples/clock.py --display capture

or::

$ python examples/clock.py --display pygame