Update README.md to clarify Windows and macOS support details and enhance installer instructions
This commit is contained in:
parent
9d39ed8201
commit
e0b316fe65
1 changed files with 15 additions and 38 deletions
53
README.md
53
README.md
|
|
@ -19,7 +19,7 @@ WebDrop Bridge embeds a web application in a Qt container with full filesystem a
|
||||||
|
|
||||||
## Features
|
## 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
|
- ✅ **Embedded Web App** - QtWebEngine provides Chromium without browser limitations
|
||||||
- ✅ **Drag Interception** - Converts text paths to native file operations
|
- ✅ **Drag Interception** - Converts text paths to native file operations
|
||||||
- ✅ **Path Whitelist** - Security-conscious file system access control
|
- ✅ **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
|
### Requirements
|
||||||
- Python 3.10+
|
- Python 3.10+
|
||||||
- Windows 10/11 or macOS 12+
|
- Windows 10/11
|
||||||
- 200 MB disk space (includes Chromium from PyInstaller)
|
- 200 MB disk space (includes Chromium from PyInstaller)
|
||||||
|
|
||||||
### Installation from Source
|
### Installation from Source
|
||||||
|
|
@ -47,7 +47,6 @@ cd webdrop-bridge
|
||||||
|
|
||||||
# Create and activate virtual environment
|
# Create and activate virtual environment
|
||||||
python -m venv venv
|
python -m venv venv
|
||||||
source venv/bin/activate # macOS/Linux
|
|
||||||
# venv\Scripts\activate.ps1 # Windows (PowerShell)
|
# venv\Scripts\activate.ps1 # Windows (PowerShell)
|
||||||
# venv\Scripts\activate.bat # Windows (cmd.exe)
|
# venv\Scripts\activate.bat # Windows (cmd.exe)
|
||||||
|
|
||||||
|
|
@ -71,8 +70,7 @@ pytest tests -v
|
||||||
tox
|
tox
|
||||||
|
|
||||||
# Build installers
|
# Build installers
|
||||||
python build/scripts/build_windows.py # Windows MSI
|
python build/scripts/build_windows.py --msi # Windows MSI
|
||||||
bash build/scripts/build_macos.sh # macOS DMG
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Project Structure
|
## Project Structure
|
||||||
|
|
@ -92,7 +90,6 @@ webdrop-bridge/
|
||||||
│ └── conftest.py # Pytest configuration
|
│ └── conftest.py # Pytest configuration
|
||||||
├── build/
|
├── build/
|
||||||
│ ├── windows/ # Windows-specific build configs
|
│ ├── windows/ # Windows-specific build configs
|
||||||
│ ├── macos/ # macOS-specific build configs
|
|
||||||
│ └── scripts/ # Build automation scripts
|
│ └── scripts/ # Build automation scripts
|
||||||
├── webapp/ # Embedded web application
|
├── webapp/ # Embedded web application
|
||||||
├── resources/
|
├── resources/
|
||||||
|
|
@ -225,48 +222,27 @@ See [CHANGELOG.md](CHANGELOG.md) for release notes.
|
||||||
### Windows MSI Installer
|
### Windows MSI Installer
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Simple build (creates standalone .exe)
|
# Build with MSI installer (recommended)
|
||||||
python build/scripts/build_windows.py
|
|
||||||
|
|
||||||
# Build with MSI installer
|
|
||||||
python build/scripts/build_windows.py --msi
|
python build/scripts/build_windows.py --msi
|
||||||
|
|
||||||
# Build and sign executable
|
# Build with code signing (requires certificate)
|
||||||
python build/scripts/build_windows.py --sign
|
python build/scripts/build_windows.py --msi --code-sign
|
||||||
```
|
```
|
||||||
|
|
||||||
Output:
|
Output:
|
||||||
- Standalone executable: `build/dist/windows/WebDropBridge.exe` (~195 MB)
|
- Portable executable: `build/dist/windows/WebDropBridge/WebDropBridge.exe` (~195 MB)
|
||||||
- Optional MSI installer: `build/dist/windows/WebDropBridge.msi`
|
- Professional MSI installer: `build/dist/windows/WebDropBridge-{version}-Setup.msi`
|
||||||
- SHA256 checksum: `build/dist/windows/WebDropBridge.exe.sha256`
|
- SHA256 checksum: `build/dist/windows/WebDropBridge/WebDropBridge.exe.sha256`
|
||||||
|
|
||||||
### macOS DMG Installer
|
**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.
|
||||||
|
|
||||||
```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`
|
|
||||||
|
|
||||||
### Creating Releases
|
### Creating Releases
|
||||||
|
|
||||||
For Forgejo/GitHub releases:
|
For Forgejo/GitHub releases:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Windows - Create release with executable
|
# Windows - Create release with MSI installer
|
||||||
powershell -ExecutionPolicy Bypass -File build/scripts/create_release.ps1
|
powershell -ExecutionPolicy Bypass -File build/scripts/create_release.ps1
|
||||||
|
|
||||||
# macOS - Create release with DMG
|
|
||||||
bash build/scripts/create_release.sh
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Development Workflow
|
## Development Workflow
|
||||||
|
|
@ -314,9 +290,10 @@ bash build/scripts/create_release.sh
|
||||||
|
|
||||||
| Platform | Version | Status | Notes |
|
| Platform | Version | Status | Notes |
|
||||||
|----------|---------|--------|-------|
|
|----------|---------|--------|-------|
|
||||||
| Windows | 10, 11 | ✅ Full | Tested on x64 |
|
| Windows | 10, 11 | ✅ Full | Tested on x64, MSI installer support |
|
||||||
| macOS | 12, 13, 14 | ✅ Full | Intel & Apple Silicon |
|
| macOS | 12+ | ⚠️ **Untested** | Possible via Qt/PySide6, but never built or tested. Theoretical support only. |
|
||||||
| Linux | Ubuntu 22.04+ | ⚠️ Partial | Limited testing |
|
|
||||||
|
**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
|
## Contributing
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue