Skip to content

Commit 21c1e6a

Browse files
authored
whisper.swiftui : update README.md (ggml-org#682)
- Slight tweaks to README for improved comprehension.
1 parent a47e812 commit 21c1e6a

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

Diff for: examples/whisper.swiftui/README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
A sample SwiftUI app using [whisper.cpp](https://github.com/ggerganov/whisper.cpp/) to do voice-to-text transcriptions.
22
See also: [whisper.objc](https://github.com/ggerganov/whisper.cpp/tree/master/examples/whisper.objc).
33

4-
To use:
4+
**Usage**:
55

66
1. Select a model from the [whisper.cpp repository](https://github.com/ggerganov/whisper.cpp/tree/master/models).[^1]
7-
2. Add the model to "whisper.swiftui.demo/Resources/models" via Xcode.
7+
2. Add the model to `whisper.swiftui.demo/Resources/models` **via Xcode**.
88
3. Select a sample audio file (for example, [jfk.wav](https://github.com/ggerganov/whisper.cpp/raw/master/samples/jfk.wav)).
9-
4. Add the model to "whisper.swiftui.demo/Resources/samples" via Xcode.
9+
4. Add the sample audio file to `whisper.swiftui.demo/Resources/samples` **via Xcode**.
1010
5. Select the "Release" [^2] build configuration under "Run", then deploy and run to your device.
1111

12+
**Note:** Pay attention to the folder path: `whisper.swiftui.demo/Resources/models` is the appropriate directory to place resources whilst `whisper.swiftui.demo/Models` is related to actual code.
13+
1214
[^1]: I recommend the tiny, base or small models for running on an iOS device.
15+
1316
[^2]: The `Release` build can boost performance of transcription. In this project, it also added `-O3 -DNDEBUG` to `Other C Flags`, but adding flags to app proj is not ideal in real world (applies to all C/C++ files), consider splitting xcodeproj in workspace in your own project.
1417

1518
![image](https://user-images.githubusercontent.com/1991296/212539216-0aef65e4-f882-480a-8358-0f816838fd52.png)

0 commit comments

Comments
 (0)