platform-nes documentation
==========================

Cross-platform NES game/engine. The documentation is organised in
three parts:

- :doc:`guide/index` — hand-written prose: setup, design notes,
  limitations, tutorials.
- :doc:`api` — public, documented, non-static interface. The surface
  application code is expected to use.
- :doc:`advanced` — full dump of every symbol in ``include/``,
  including undocumented and static ones. Superset of the API reference.

.. toctree::
   :maxdepth: 2
   :caption: Contents

   guide/index
   api
   advanced

Indices
=======

* :ref:`genindex`
* :ref:`search`