4 files changed, 68 insertions, 1 deletions
diff --git a/doc/examples.qdoc b/doc/examples.qdoc
index c13b2f1..04eb651 100644
--- a/doc/examples.qdoc
+++ b/doc/examples.qdoc
@@ -37,6 +37,7 @@
 
    \list
     \li \l{contentplugin}{Content Plugin}
+    \li \l{customruntime}{Custom Runtime}
    \endlist
 
 */
diff --git a/doc/examples/customruntime.qdoc b/doc/examples/customruntime.qdoc
new file mode 100644
index 0000000..fdd2e2f
--- /dev/null
+++ b/doc/examples/customruntime.qdoc
@@ -0,0 +1,66 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 Luxoft Sweden AB
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QmlLive tool.
+**
+** $QT_BEGIN_LICENSE:GPL-QTAS$
+** Commercial License Usage
+** Licensees holding valid commercial Qt Automotive Suite licenses may use
+** this file in accordance with the commercial license agreement provided
+** with the Software or, alternatively, in accordance with the terms
+** contained in a written agreement between you and The Qt Company.  For
+** licensing terms and conditions see https://www.qt.io/terms-conditions.
+** For further information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 or (at your option) any later version
+** approved by the KDE Free Qt Foundation. The licenses are as published by
+** the Free Software Foundation and appearing in the file LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+** SPDX-License-Identifier: GPL-3.0
+**
+****************************************************************************/
+/*!
+\example customruntime
+\title Custom Runtime Example
+
+\brief Demonstrates how to create a Custom QmlLive Runtime
+
+\image customruntime-example.png Screenshot of the Custom QmlLive Runtime
+
+Creating a custom runtime with QmlLive features allows you to use your QML
+view setup, combined with additional C++ code and the QmlLive system.
+
+Start with the \l LiveNodeEngine class. We need to modify this class to be
+able to receive workspace changes and active document updates. By default,
+the IPC listens to port 10234.
+
+The code snippet below shows a minimal custom QmlLive runtime:
+
+\snippet customruntime/main.cpp 0
+
+To specify project depedencies on platforms that support \c pkg-config,
+add the following line to your project file. This is assuming QmlLive is
+installed on your build host:
+
+\code
+CONFIG += link_pkgconfig
+PKGCONFIG += qmllive
+\endcode
+
+In case if your system doesn't support \c pkg-config, to compile everything
+directly into your application, include file \c{$(QMLLIVEPROJECT)/src/src.pri}
+by adding the line into your project file:
+
+\code
+include(src.pri)
+\endcode
+*/
diff --git a/doc/images/customruntime-example.png b/doc/images/customruntime-example.png
new file mode 100644
index 0000000..d5aba33
--- /dev/null
+++ b/doc/images/customruntime-example.png
diff --git a/doc/usage.qdoc b/doc/usage.qdoc
index ff4eeef..1fa6d17 100644
--- a/doc/usage.qdoc
+++ b/doc/usage.qdoc
@@ -184,7 +184,7 @@ on the port 10234.
 
 Here is a short example of a minimal custom QmlLive runtime:
 
-\snippet ../examples/app/main.cpp 0
+\snippet ../examples/customruntime/main.cpp 0
 
 On platforms where pkg-config is supported simply add the following to your
 project file if QmlLive is installed on your build host: