Nuklear/docs/source/index.rst
2017-09-21 18:18:57 +07:00

36 lines
970 B
ReStructuredText

.. Nuklear documentation master file
Nuklear
===================================
This is a minimal state immediate mode graphical user interface toolkit written in ANSI C and licensed under public domain.
It was designed as a simple embeddable user interface for application and does not have any dependencies, a default renderbackend or OS window and input handling but instead provides a very modular library approach by using simple input state for input and draw commands describing primitive shapes as output.
Rather than provide a layered library that tries to abstract over a number of platform and render backends, Nuklear only focuses on the actual UI.
Overview
========================
.. toctree::
overview/architecture
overview/best_practices
overview/getting_started
Learn
========================
.. toctree::
guides/walk_throughs
guides/examples
API Documentation
========================
.. toctree::
:maxdepth 3
api/reference