From d862e56e34ad1a76836cc2716b473a61879f2205 Mon Sep 17 00:00:00 2001
From: Maze Winther <mazewinther@gmail.com>
Date: Fri, 27 Mar 2026 21:15:00 +0100
Subject: feat: init desktop app

---
 apps/desktop/README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 apps/desktop/README.md

(limited to 'apps/desktop/README.md')

diff --git a/apps/desktop/README.md b/apps/desktop/README.md
new file mode 100644
index 00000000..9cff04e1
--- /dev/null
+++ b/apps/desktop/README.md
@@ -0,0 +1,47 @@
+# Desktop
+
+The native desktop app, built with [GPUI](https://gpui.rs).
+
+## Getting started
+
+**1. Install Rust:**
+
+```bash
+# Linux / macOS / WSL
+./script/setup-rust
+```
+
+```powershell
+# Windows
+powershell -ExecutionPolicy Bypass -File .\script\setup-rust.ps1
+```
+
+Both scripts skip installation if Rust is already present. On Linux/macOS/WSL only: after a fresh install, reload your shell with `source "$HOME/.cargo/env"`
+
+**2. Install native dependencies:**
+
+```bash
+# Linux / macOS / WSL
+./apps/desktop/script/setup
+```
+
+```powershell
+# Windows
+powershell -ExecutionPolicy Bypass -File .\apps\desktop\script\setup.ps1
+```
+
+**3. Run:**
+
+```bash
+cargo run -p opencut-desktop
+```
+
+## Platform notes
+
+**Linux:** supports apt (Debian/Ubuntu/Mint), dnf (Fedora/RHEL), and pacman (Arch).
+
+**macOS:** installs Xcode Command Line Tools if missing.
+
+**Windows:** the setup script checks for Visual Studio Build Tools. If missing, it prints the install link.
+
+**WSL:** runs the same scripts as Linux. Window rendering works via WSLg on Windows 11 and Windows 10 22H2+. If you're on an older build, test on the host instead.
-- 
cgit v1.3.1