Skip to content

Commit 4e1b69d

Browse files
committed
chore: Improve README by explaining how WinBoat works from a technical perspective
1 parent 6cbd8de commit 4e1b69d

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,16 @@
2424
WinBoat is currently in beta, so expect to occasionally run into hiccups and bugs. You should be comfortable with some level of troubleshooting if you decide to try it, however we encourage you to give it a shot anyway.
2525

2626
## Features
27-
2827
- **🎨 Elegant Interface**: Sleek and intuitive interface that seamlessly integrates Windows into your Linux desktop environment, making it feel like a native experience
2928
- **📦 Automated Installs**: Simple installation process through our interface - pick your preferences & specs and let us handle the rest
3029
- **🚀 Run Any App**: If it runs on Windows, it can run on WinBoat. Enjoy the full range of Windows applications as native OS-level windows in your Linux environment
3130
- **🖥️ Full Windows Desktop**: Access the complete Windows desktop experience when you need it, or run individual apps seamlessly integrated into your Linux workflow
3231
- **📁 Filesystem Integration**: Your home directory is mounted in Windows, allowing easy file sharing between the two systems without any hassle
3332
- **✨ And many more**: Smartcard passthrough, resource monitoring, and more features being added regularly
3433

34+
## How Does It Work?
35+
WinBoat is an Electron app which allows you to run Windows apps on Linux using a containerized approach. Windows runs as a VM inside a Docker container, we communicate with it using the [WinBoat Guest Server](https://github.com/TibixDev/winboat/tree/main/guest_server) to retrieve data we need from Windows. For compositing applications as native OS-level windows, we use FreeRDP together with Windows's RemoteApp protocol.
36+
3537
## Prerequisites
3638
Before running WinBoat, ensure your system meets the following requirements:
3739

0 commit comments

Comments
 (0)