mirror of
https://github.com/samsonjs/vibetunnel.git
synced 2026-03-29 10:05:53 +00:00
a9fd66c291
- Move all macOS-specific code from root to mac/ directory - Move app icons and assets to dedicated assets/ directory - Update GitHub workflows for new structure - Consolidate documentation files - Clean up root directory for better multi-platform organization
64 lines
No EOL
1.5 KiB
Markdown
64 lines
No EOL
1.5 KiB
Markdown
# VibeTunnel macOS App
|
|
|
|
This directory contains the macOS version of VibeTunnel.
|
|
|
|
## Quick Start
|
|
|
|
### Building
|
|
```bash
|
|
# Using Xcode
|
|
xcodebuild -workspace VibeTunnel.xcworkspace -scheme VibeTunnel build
|
|
|
|
# Using build script
|
|
./scripts/build.sh
|
|
```
|
|
|
|
### Running Tests
|
|
```bash
|
|
xcodebuild -workspace VibeTunnel.xcworkspace -scheme VibeTunnel test
|
|
```
|
|
|
|
### Creating Release
|
|
```bash
|
|
./scripts/build.sh --configuration Release --sign
|
|
./scripts/create-dmg.sh build/Build/Products/Release/VibeTunnel.app
|
|
```
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
mac/
|
|
├── VibeTunnel/ # Source code
|
|
│ ├── Core/ # Core services and models
|
|
│ ├── Presentation/ # Views and UI components
|
|
│ └── Utilities/ # Helper utilities
|
|
├── VibeTunnelTests/ # Unit tests
|
|
├── scripts/ # Build and release scripts
|
|
├── docs/ # macOS-specific documentation
|
|
└── private/ # Signing keys (not in git)
|
|
```
|
|
|
|
## Scripts
|
|
|
|
- `build.sh` - Build the app with optional signing
|
|
- `create-dmg.sh` - Create a DMG for distribution
|
|
- `release.sh` - Full release process
|
|
- `monitor-ci.sh` - Monitor CI build status
|
|
- `sign-and-notarize.sh` - Code signing and notarization
|
|
|
|
## Documentation
|
|
|
|
See `docs/` for macOS-specific documentation:
|
|
- Code signing setup
|
|
- Release process
|
|
- Sparkle update framework
|
|
- Development signing
|
|
|
|
## CI/CD
|
|
|
|
The app is built automatically on GitHub Actions:
|
|
- On every push to main
|
|
- On pull requests
|
|
- For releases (tagged with v*)
|
|
|
|
See `.github/workflows/swift.yml` for the build configuration. |