Add iOS client section to main README/ modify iOS README
This commit is contained in:
@@ -41,7 +41,56 @@ The app streams microphone audio to a WhisperLive server via WebSocket and displ
|
|||||||
|
|
||||||
4. Run the app on a physical device (recommended)
|
4. Run the app on a physical device (recommended)
|
||||||
|
|
||||||
|
## Running on a Physical Device (with Free Apple ID)
|
||||||
|
|
||||||
|
You can run this app on a real iPhone without a paid Apple Developer account. Follow these steps:
|
||||||
|
|
||||||
|
### 1. Register a Free Apple ID in Xcode
|
||||||
|
|
||||||
|
1. Open Xcode ▸ Settings… (or Preferences) ▸ **Accounts**
|
||||||
|
2. Click the **+** button ▸ Select **Apple ID**
|
||||||
|
3. Sign in with your Apple ID (a free one is fine)
|
||||||
|
4. A "Personal Team" will be created automatically
|
||||||
|
|
||||||
|
> ✅ You can deploy up to 3 apps on a physical device using a free Apple ID with a 7-day provisioning profile.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2. Set Up Signing in Your Project
|
||||||
|
|
||||||
|
1. In Xcode, select your **project** in the Project Navigator
|
||||||
|
2. Go to **TARGETS ▸ YourAppName ▸ Signing & Capabilities**
|
||||||
|
3. Set **Team** to your Personal Team
|
||||||
|
4. Set a unique **Bundle Identifier** (e.g., `com.yourname.whisperlive`)
|
||||||
|
5. Make sure **Automatically manage signing** is checked
|
||||||
|
6. If a red warning appears, click **"Resolve Issues"**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 3. Connect and Trust Your iPhone
|
||||||
|
|
||||||
|
1. Connect your iPhone via USB
|
||||||
|
2. When prompted, tap **“Trust This Computer”** on your iPhone
|
||||||
|
3. Make sure your iPhone appears in Xcode's device list
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 4. Enable Developer Mode on iPhone
|
||||||
|
|
||||||
|
1. Press the **Build (▶︎)** button in Xcode
|
||||||
|
2. Your iPhone will ask to enable **Developer Mode**
|
||||||
|
3. On iPhone, go to:
|
||||||
|
**Settings ▸ Privacy & Security ▸ Developer Mode**
|
||||||
|
4. Enable it and restart the device if required
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Now you can run and debug the app on your real device!
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Folder Structure
|
## Folder Structure
|
||||||
|
```
|
||||||
Audio-Transcription-iOS/
|
Audio-Transcription-iOS/
|
||||||
├── AudioViewModel.swift
|
├── AudioViewModel.swift
|
||||||
├── AudioStreamer.swift
|
├── AudioStreamer.swift
|
||||||
@@ -50,7 +99,7 @@ Audio-Transcription-iOS/
|
|||||||
├── WhisperLive_iOS_ClientApp.swift
|
├── WhisperLive_iOS_ClientApp.swift
|
||||||
├── Info.plist
|
├── Info.plist
|
||||||
├── README.md
|
├── README.md
|
||||||
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
@@ -147,6 +147,12 @@ client(hls_url="http://as-hls-ww-live.akamaized.net/pool_904/live/ww/bbc_1xtra/b
|
|||||||
- Run the server with your desired backend as shown [here](https://github.com/collabora/WhisperLive?tab=readme-ov-file#running-the-server).
|
- Run the server with your desired backend as shown [here](https://github.com/collabora/WhisperLive?tab=readme-ov-file#running-the-server).
|
||||||
- Transcribe audio directly from your browser using our Chrome or Firefox extensions. Refer to [Audio-Transcription-Chrome](https://github.com/collabora/whisper-live/tree/main/Audio-Transcription-Chrome#readme) and https://github.com/collabora/WhisperLive/blob/main/TensorRT_whisper.md
|
- Transcribe audio directly from your browser using our Chrome or Firefox extensions. Refer to [Audio-Transcription-Chrome](https://github.com/collabora/whisper-live/tree/main/Audio-Transcription-Chrome#readme) and https://github.com/collabora/WhisperLive/blob/main/TensorRT_whisper.md
|
||||||
|
|
||||||
|
## iOS Client
|
||||||
|
|
||||||
|
Use WhisperLive on iOS with our native iOS client.
|
||||||
|
Refer to [`ios-client`](https://github.com/collabora/WhisperLive/tree/main/Audio-Transcription-iOS) and [`ios-client/README.md`](https://github.com/collabora/WhisperLive/blob/main/Audio-Transcription-iOS/README.md) for setup and usage instructions.
|
||||||
|
|
||||||
|
|
||||||
## Whisper Live Server in Docker
|
## Whisper Live Server in Docker
|
||||||
- GPU
|
- GPU
|
||||||
- Faster-Whisper
|
- Faster-Whisper
|
||||||
|
|||||||
Reference in New Issue
Block a user