From cdde968f15d69812e830c9d621b597b78c7220ba Mon Sep 17 00:00:00 2001 From: Jonathan Daugherty Date: Thu, 23 Jul 2015 18:16:21 -0700 Subject: [PATCH] docs: minor fixes --- docs/index.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 13c8147..0d43b3f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 **************************