jtdaugherty/brick
1
1
Fork 0
mirror of https://github.com/jtdaugherty/brick.git synced 2024-12-02 11:05:10 +03:00
Code Issues Projects Releases Wiki Activity

docs: minor fixes

Browse Source
This commit is contained in:
Jonathan Daugherty 2015-07-23 18:16:21 -07:00
parent eb8238990b
commit cdde968f15
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/index.rst
View File

@ -112,14 +112,15 @@ we will handle with ``brick`` applications. However, that is often not
enough. Imagine an application with multiple threads and network or
disk I/O. Such an application will need to have its own internal events
to pass to the event handler as (for example) network data arrives. To
accomodate this we allow an ``App`` to use an event type of your own
accommodate this we allow an ``App`` to use an event type of your own
design, so long as it provides a constructor for ``vty``'s ``Event``
type (``appLiftVtyEvent``).
type (``appLiftVtyEvent``). For more details, see `Using Your Own Event
Type`_.
The various fields of ``App`` will be described in the sections below.
To run an ``App``, we pass it to ``Brick.Main.defaultMain`` or
``Brick.Main.customMain``.
``Brick.Main.customMain`` along with an initial application state value.
appDraw: Drawing an Interface
-----------------------------
@ -135,6 +136,8 @@ Using Your Own Event Type
appLiftVtyEvent
customMain
Starting up: appStartEvent
**************************