]> git.djapps.eu Git - pkg/ggml/sources/whisper.cpp/commitdiff
whisper.swiftui : update README.md (#682)
authorJonno <redacted>
Wed, 29 Mar 2023 20:04:38 +0000 (06:04 +1000)
committerGitHub <redacted>
Wed, 29 Mar 2023 20:04:38 +0000 (23:04 +0300)
- Slight tweaks to README for improved comprehension.

examples/whisper.swiftui/README.md

index 4db6cd39538fca8fc2ecceacd9ced1b59c7949c6..d321a3b1a8528fa03fe63d492d872581cccc3172 100644 (file)
@@ -1,15 +1,18 @@
 A sample SwiftUI app using [whisper.cpp](https://github.com/ggerganov/whisper.cpp/) to do voice-to-text transcriptions.
 See also: [whisper.objc](https://github.com/ggerganov/whisper.cpp/tree/master/examples/whisper.objc).
 
-To use:
+**Usage**:
 
 1. Select a model from the [whisper.cpp repository](https://github.com/ggerganov/whisper.cpp/tree/master/models).[^1]
-2. Add the model to "whisper.swiftui.demo/Resources/models" via Xcode.
+2. Add the model to `whisper.swiftui.demo/Resources/models` **via Xcode**.
 3. Select a sample audio file (for example, [jfk.wav](https://github.com/ggerganov/whisper.cpp/raw/master/samples/jfk.wav)).
-4. Add the model to "whisper.swiftui.demo/Resources/samples" via Xcode.
+4. Add the sample audio file to `whisper.swiftui.demo/Resources/samples` **via Xcode**.
 5. Select the "Release" [^2] build configuration under "Run", then deploy and run to your device.
 
+**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.
+
 [^1]: I recommend the tiny, base or small models for running on an iOS device.
+
 [^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.
 
 ![image](https://user-images.githubusercontent.com/1991296/212539216-0aef65e4-f882-480a-8358-0f816838fd52.png)