HIM-public/webdrop-bridge
HIM-public/webdrop-bridge
5
0
Fork 0
Code Issues 3 Pull requests Projects 1 Releases 1 Packages Wiki Activity Actions

Update README.md to clarify Windows and macOS support details and enhance installer instructions

Browse source
This commit is contained in:
claudi 2026-02-20 12:32:18 +01:00
parent 9d39ed8201
commit e0b316fe65
1 changed files with 15 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

53
README.md
View file

@ -19,7 +19,7 @@ WebDrop Bridge embeds a web application in a Qt container with full filesystem a
## Features
- ✅ **Qt-based Architecture** - Native Windows & macOS support via PySide6
- ✅ **Qt-based Architecture** - Professional Windows support via PySide6 (macOS support planned)
- ✅ **Embedded Web App** - QtWebEngine provides Chromium without browser limitations
- ✅ **Drag Interception** - Converts text paths to native file operations
- ✅ **Path Whitelist** - Security-conscious file system access control
@ -35,7 +35,7 @@ WebDrop Bridge embeds a web application in a Qt container with full filesystem a
### Requirements
- Python 3.10+
- Windows 10/11 or macOS 12+
- Windows 10/11
- 200 MB disk space (includes Chromium from PyInstaller)
### Installation from Source
@ -47,7 +47,6 @@ cd webdrop-bridge
# Create and activate virtual environment
python -m venv venv
source venv/bin/activate # macOS/Linux
# venv\Scripts\activate.ps1 # Windows (PowerShell)
# venv\Scripts\activate.bat # Windows (cmd.exe)
@ -71,8 +70,7 @@ pytest tests -v
tox
# Build installers
python build/scripts/build_windows.py # Windows MSI
bash build/scripts/build_macos.sh # macOS DMG
python build/scripts/build_windows.py --msi # Windows MSI
```
## Project Structure
@ -92,7 +90,6 @@ webdrop-bridge/
│ └── conftest.py # Pytest configuration
├── build/
│ ├── windows/ # Windows-specific build configs
│ ├── macos/ # macOS-specific build configs
│ └── scripts/ # Build automation scripts
├── webapp/ # Embedded web application
├── resources/
@ -225,48 +222,27 @@ See [CHANGELOG.md](CHANGELOG.md) for release notes.
### Windows MSI Installer
```bash
# Simple build (creates standalone .exe)
python build/scripts/build_windows.py
# Build with MSI installer
# Build with MSI installer (recommended)
python build/scripts/build_windows.py --msi
# Build and sign executable
python build/scripts/build_windows.py --sign
# Build with code signing (requires certificate)
python build/scripts/build_windows.py --msi --code-sign
```
Output:
- Standalone executable: `build/dist/windows/WebDropBridge.exe` (~195 MB)
- Optional MSI installer: `build/dist/windows/WebDropBridge.msi`
- SHA256 checksum: `build/dist/windows/WebDropBridge.exe.sha256`
- Portable executable: `build/dist/windows/WebDropBridge/WebDropBridge.exe` (~195 MB)
- Professional MSI installer: `build/dist/windows/WebDropBridge-{version}-Setup.msi`
- SHA256 checksum: `build/dist/windows/WebDropBridge/WebDropBridge.exe.sha256`
### macOS DMG Installer
```bash
# Build DMG (requires macOS)
bash build/scripts/build_macos.sh
# Build with code signing
SIGN_APP=true bash build/scripts/build_macos.sh
# Build with notarization
NOTARIZE_APP=true bash build/scripts/build_macos.sh
```
Output:
- DMG installer: `build/dist/macos/WebDropBridge.dmg`
- App bundle: `build/dist/macos/WebDropBridge.app`
**Note on macOS**: Build scripts exist for macOS (DMG generation), but have never been built or tested. macOS support is theoretical at this point. The Qt/PySide6 architecture should support macOS, but platform-specific testing and validation would be required.
### Creating Releases
For Forgejo/GitHub releases:
```bash
# Windows - Create release with executable
# Windows - Create release with MSI installer
powershell -ExecutionPolicy Bypass -File build/scripts/create_release.ps1
# macOS - Create release with DMG
bash build/scripts/create_release.sh
```
## Development Workflow
@ -314,9 +290,10 @@ bash build/scripts/create_release.sh
| Platform | Version | Status | Notes |
|----------|---------|--------|-------|
| Windows | 10, 11 | ✅ Full | Tested on x64 |
| macOS | 12, 13, 14 | ✅ Full | Intel & Apple Silicon |
| Linux | Ubuntu 22.04+ | ⚠️ Partial | Limited testing |
| Windows | 10, 11 | ✅ Full | Tested on x64, MSI installer support |
| macOS | 12+ | ⚠️ **Untested** | Possible via Qt/PySide6, but never built or tested. Theoretical support only. |
**Note**: WebDrop Bridge is currently developed and tested exclusively on Windows. While the Qt/PySide6 framework supports macOS, we cannot guarantee functionality without actual macOS testing and validation. Contributions for macOS support validation are welcome.
## Contributing