Permalink
Browse files

The idea of a shared README file didn't work that well

  • Loading branch information...
1 parent a6defbd commit 35aeeb500b9ad8910d969be53dd2f759f263fb34 @superbobry superbobry committed Jun 27, 2011
Showing with 3 additions and 3 deletions.
  1. +2 −3 README
  2. +1 −0 README.rst
View
5 README
@@ -48,14 +48,13 @@ from `GitHub <http://github.com/selectel/pyte>`_ and run ``python setup.py insta
Quick example
-------------
-There are two important classes in ``pyte``:
-:class:`~pyte.screens.Screen` and :class:`~pyte.streams.Stream`. The
+There are two important classes in ``pyte``: ``Screen`` and ``Stream``. The
``Screen`` is the terminal screen emulator. It maintains an in-memory
buffer of text and text-attributes to display on screen. The ``Stream``
is the stream processor. It manages the state of the input and dispatches
events to anything that's listening about things that are going on.
Events are things like ``LINEFEED``, ``DRAW "a"``, or ``CURSOR_POSITION 10 10``.
-See the :ref:`API <api>` for more details.
+See the `API documentation` for more details.
In general, if you just want to know what's being displayed on screen you
can do something like the following:
View
1 README.rst

0 comments on commit 35aeeb5

Please sign in to comment.