summaryrefslogtreecommitdiffstats
path: root/doc/suil.rst
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2020-12-21 18:13:18 +0100
committerDavid Robillard <d@drobilla.net>2020-12-21 19:35:11 +0100
commita392684c178b0f4bccdec06116048213bae1b491 (patch)
tree48ca5569c155623a7983e48f302796129737b861 /doc/suil.rst
parent4c3cea9274a8596197ae73a97eb31187cc18770c (diff)
downloadsuil-a392684c178b0f4bccdec06116048213bae1b491.tar.gz
suil-a392684c178b0f4bccdec06116048213bae1b491.tar.bz2
suil-a392684c178b0f4bccdec06116048213bae1b491.zip
Generate documentation with Sphinx
Diffstat (limited to 'doc/suil.rst')
-rw-r--r--doc/suil.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/suil.rst b/doc/suil.rst
new file mode 100644
index 0000000..c5dc5ab
--- /dev/null
+++ b/doc/suil.rst
@@ -0,0 +1,14 @@
+####
+Suil
+####
+
+Suil is a library for loading and wrapping LV2 plugin UIs.
+
+With Suil,
+a host written in one supported toolkit can embed a plugin UI written in another.
+Suil insulates hosts from toolkit libraries used by plugin UIs.
+For example,
+a Gtk host can embed a Qt UI without linking against Qt at compile time.
+
+Suil also handles the embedding of native platform UIs (which are recommended) in common toolkits,
+for example embedding an X11 UI in a Gtk host.