From 39165eb472de199d8c6a5270d56b9f42178e78fe Mon Sep 17 00:00:00 2001
From: jika <vandechat@tutanota.com>
Date: Sat, 5 Aug 2023 00:37:36 +0200
Subject: [PATCH] add some instruction in readme

---
 Readme.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..2aa2b2b
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,30 @@
+# Deckui
+
+Attempt at a customizable GUI to control some aspect of your computer via a remote device (i.e. SBC with touchscreen).
+
+## Prerequisites
+
+* Have rust installed see [rustup](https://rustup.rs)
+
+
+## Build an Run
+
+### If you have cargo-watch and runcc installed 
+
+* You can just run : 
+  ```sh
+   cargo runcc -c runcc.yml
+   ```
+Take a look at rock64.yml to run the ui on a remote device during developpement
+
+### In all case
+
+* Run the app/server
+
+  ```sh
+    cargo run -p app
+   ```
+* Run the remote 
+  ```sh
+   cargo run -p remote
+   ```