From 961f147a439fd55a49a076957bcd5ee2ae4e7f85 Mon Sep 17 00:00:00 2001
From: Ferdinand Schober <ferdinand.schober@fau.de>
Date: Tue, 20 Sep 2022 00:52:47 +0200
Subject: [PATCH] add build instructions

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

diff --git a/README.md b/README.md
index 83fe6f0..13565f3 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,19 @@ The protocols used for the virtual mouse and virtual keyboard drivers are curren
 
 In order for layershell surfaces to be able to lock the pointer using the pointer\_constraints protocol [this patch](https://github.com/swaywm/sway/pull/7178) needs to be applied to sway.
 
+## Build and run
+Run Server (sending key events):
+```sh
+cargo run --bin server
+```
+
+Run Client (receiving key events):
+```sh
+cargo run --bin client
+```
+
+As mentioned the server will only work on sway compiled from source with the above mentioned patch applied.
+
 ## TODO
 - [x] Capture the actual mouse events on the server side via a wayland client and send them to the client
 - [x] Mouse grabbing