summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2016-03-10 21:59:21 +0100
committerwm4 <wm4@nowhere>2016-03-10 21:59:21 +0100
commit06fcabd06ef63615a0d6518b381b4921788103e1 (patch)
tree75e51d7fbb60d05c84069245f87dee0e6a16068d
parent9bc5c020de87fdffc40c9103992b26fe80cfe944 (diff)
downloadmpv-06fcabd06ef63615a0d6518b381b4921788103e1.tar.bz2
mpv-06fcabd06ef63615a0d6518b381b4921788103e1.tar.xz
DOCS: add some hints to the new examples repository
-rw-r--r--DOCS/libmpv-client-api.rst14
-rw-r--r--libmpv/client.h3
2 files changed, 16 insertions, 1 deletions
diff --git a/DOCS/libmpv-client-api.rst b/DOCS/libmpv-client-api.rst
new file mode 100644
index 0000000000..eeb5fe0408
--- /dev/null
+++ b/DOCS/libmpv-client-api.rst
@@ -0,0 +1,14 @@
+Client API (libmpv) documentation and examples
+==============================================
+
+libmpv lets you embed mpv as a library. It is meant to enable development of
+GUI frontends.
+
+Since libmpv merely allows access to underlying mechanisms that can control
+mpv, documentation is spread over a few places:
+
+- https://github.com/mpv-player/mpv/blob/master/libmpv/client.h
+- http://mpv.io/manual/master/#options
+- http://mpv.io/manual/master/#list-of-input-commands
+- http://mpv.io/manual/master/#properties
+- https://github.com/mpv-player/mpv-examples/tree/master/libmpv
diff --git a/libmpv/client.h b/libmpv/client.h
index d5faf45ba7..4ba96bd861 100644
--- a/libmpv/client.h
+++ b/libmpv/client.h
@@ -63,7 +63,8 @@ extern "C" {
* * http://mpv.io/manual/master/#list-of-input-commands
* * http://mpv.io/manual/master/#properties
*
- * You can also look at the examples in DOCS/client_api_examples/.
+ * You can also look at the examples here:
+ * * https://github.com/mpv-player/mpv-examples/tree/master/libmpv
*
* Event loop
* ----------