Skip to content

Commit

Permalink
Merge edf5637 into 8f33f81
Browse files Browse the repository at this point in the history
  • Loading branch information
thijstriemstra committed Oct 30, 2017
2 parents 8f33f81 + edf5637 commit 7d6e063
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .readthedocs.yml
@@ -1,5 +1,5 @@
python:
version: 2.7
pip_install: true
pip_install: false
extra_requirements:
- docs
4 changes: 4 additions & 0 deletions README.rst
Expand Up @@ -33,6 +33,10 @@ without running a physical device. These include:
* Animated GIF animator
* Real-time ASCII-art emulator

Documentation
-------------
Documentation can be found on https://luma-emulator.readthedocs.io.

.. image:: https://raw.githubusercontent.com/rm-hull/luma.oled/master/doc/images/clock_anim.gif?raw=true
:alt: clock

Expand Down
14 changes: 14 additions & 0 deletions doc/intro.rst
@@ -1,4 +1,18 @@
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.

Check out the `examples <https://github.com/rm-hull/luma.examples/blob/master/README.rst#emulators>`__
on how to use the luma.emulator devices.

0 comments on commit 7d6e063

Please sign in to comment.