diff options
| author | David Robillard <d@drobilla.net> | 2020-11-26 16:07:41 +0100 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2020-11-26 17:09:15 +0100 |
| commit | 503ba93a4ebf316ab01b468808e4cda2da8b863e (patch) | |
| tree | ebfbcd7829879def472028617abeb021c9a26e64 /doc/deployment.rst | |
| parent | caf3f4fc314608d8d8f8be853f4bde6bb50188b0 (diff) | |
| download | pugl-503ba93a4ebf316ab01b468808e4cda2da8b863e.tar.gz pugl-503ba93a4ebf316ab01b468808e4cda2da8b863e.tar.bz2 pugl-503ba93a4ebf316ab01b468808e4cda2da8b863e.zip | |
Generate documentation with Sphinx
Diffstat (limited to 'doc/deployment.rst')
| -rw-r--r-- | doc/deployment.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/deployment.rst b/doc/deployment.rst new file mode 100644 index 0000000..ffbeae9 --- /dev/null +++ b/doc/deployment.rst @@ -0,0 +1,23 @@ +########## +Using Pugl +########## + +Pugl is designed for flexible deployment, +so the exact method of building against it depends on your approach. + +When targeting systems with pkg-config_, +packages are provided that link against the core platform library and the desired backend, +along with any backend dependencies: + +- ``pugl-cairo-0`` +- ``pugl-gl-0`` +- ``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. + +.. _pkg-config: https://www.freedesktop.org/wiki/Software/pkg-config/ |