aboutsummaryrefslogtreecommitdiffstats
path: root/doc/c/overview.rst
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2021-01-06 23:53:32 +0100
committerDavid Robillard <d@drobilla.net>2021-01-06 23:53:32 +0100
commit94e30b9c3c188dfdf4765f026872f95ea3cfdda2 (patch)
tree2a74ee400a172703137e5273df2ac93d588523cc /doc/c/overview.rst
parentd2a6fd3f725f7f174535c49d78d07567e12c84d8 (diff)
downloadpugl-94e30b9c3c188dfdf4765f026872f95ea3cfdda2.tar.gz
pugl-94e30b9c3c188dfdf4765f026872f95ea3cfdda2.tar.bz2
pugl-94e30b9c3c188dfdf4765f026872f95ea3cfdda2.zip
Simplify documentation structure and use LV2 theme
Diffstat (limited to 'doc/c/overview.rst')
-rw-r--r--doc/c/overview.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/c/overview.rst b/doc/c/overview.rst
index f597aab..4bd024d 100644
--- a/doc/c/overview.rst
+++ b/doc/c/overview.rst
@@ -9,6 +9,12 @@ The Pugl API revolves around two main objects: the `world` and the `view`.
An application creates a world to manage top-level state,
then creates one or more views to display.
+The core API (excluding backend-specific components) is declared in ``pugl.h``:
+
+.. code-block:: c
+
+ #include <pugl/pugl.h>
+
.. toctree::
world
@@ -16,3 +22,5 @@ then creates one or more views to display.
events
event-loop
shutting-down
+
+.. _pkg-config: https://www.freedesktop.org/wiki/Software/pkg-config/