From 05aa4dad8095c120b686454f434f5b2d556a54c8 Mon Sep 17 00:00:00 2001
From: Sergio Martins <sergio.martins@kdab.com>
Date: Thu, 26 Dec 2024 16:37:34 +0000
Subject: [PATCH] docs: Add instructions

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index d1c5a98..caf86c4 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,18 @@ Can be used to launch a 100% flutter app or to integrate flutter into an existin
 - Vulkan / Metal / D3D
 - Integrate into QWidget or QtQuick
 
+## Instructions
+
+Install `ms-vscode-remote.remote-containers` extension in vscode and open the `.devcontainer`.
+
+Build the embedder.
+
+Build the example by running `build_example.sh`.
+
+Run the example:
+`./build-dev/qtembedder -m -e examples/default_counter_app`
+
+
 ## Licensing
 
 Licensed as GPL-3, feel free to contact us for other licensing options.