summaryrefslogtreecommitdiffstats
path: root/doc/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/index.rst')
-rw-r--r--doc/index.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..7f81dbd
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,23 @@
+..
+ Copyright 2020-2023 David Robillard <d@drobilla.net>
+ SPDX-License-Identifier: ISC
+
+####
+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.
+
+.. toctree::
+
+ overview
+ api/suil