aboutsummaryrefslogtreecommitdiffstats
path: root/doc/deployment.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/deployment.rst')
-rw-r--r--doc/deployment.rst15
1 files changed, 9 insertions, 6 deletions
diff --git a/doc/deployment.rst b/doc/deployment.rst
index 4afc51a..1e98e62 100644
--- a/doc/deployment.rst
+++ b/doc/deployment.rst
@@ -9,15 +9,18 @@ Building Against Pugl
When Pugl is installed,
pkg-config_ packages are provided that link with the core platform library and desired backend:
-- ``pugl-cairo-0``
-- ``pugl-gl-0``
-- ``pugl-vulkan-0``
+.. code-block:: sh
+
+ pkg-config --cflags --libs pugl-0
+ pkg-config --cflags --libs pugl-cairo-0
+ pkg-config --cflags --libs pugl-gl-0
+ pkg-config --cflags --libs pugl-vulkan-0
Depending on one of these packages should be all that is necessary to use Pugl,
but details on the individual libraries that are installed are available in the README.
-If you are instead including the source directly in your project,
-the structure is quite simple and hopefully obvious.
-It is only necessary to copy the platform and backend implementations that you need.
+If you are instead building directly from source,
+all of the implementation files are in the ``src`` directory.
+It is only necessary to build the platform and backend implementations that you need.
.. _pkg-config: https://www.freedesktop.org/wiki/Software/pkg-config/