Update whisper.cpp build instructions

This commit is contained in:
Beingpax 2025-03-20 17:24:12 +05:45
parent f6dfad00ae
commit 7a16943add

View File

@ -8,27 +8,32 @@ Before you begin, ensure you have:
- macOS 14.0 or later
- Xcode (latest version recommended)
- Swift (latest version recommended)
- [whisper.cpp](https://github.com/ggerganov/whisper.cpp) properly set up
- Follow the installation instructions in the whisper.cpp repository
- Make sure you can build and run the basic examples
- The library should be properly linked in your environment
## Building Steps
## Building whisper.cpp Framework
1. Clone the repository
1. Clone and build whisper.cpp:
```bash
git clone https://github.com/ggerganov/whisper.cpp.git
cd whisper.cpp
./build-xcframework.sh
```
This will create the XCFramework at `build-apple/whisper.xcframework`.
## Building VoiceInk
1. Clone the VoiceInk repository:
```bash
git clone https://github.com/Beingpax/VoiceInk.git
cd VoiceInk
```
2. Open the project in Xcode
```bash
open VoiceInk.xcodeproj
```
2. Add the whisper.xcframework to your project:
- Drag and drop `../whisper.cpp/build-apple/whisper.xcframework` into the project navigator, or
- Add it manually in the "Frameworks, Libraries, and Embedded Content" section of project settings
3. Build and Run
- Build the project using Cmd+B or Product > Build
- Run the project using Cmd+R or Product > Run
- Build the project using Cmd+B or Product > Build
- Run the project using Cmd+R or Product > Run
## Development Setup
@ -38,8 +43,7 @@ open VoiceInk.xcodeproj
2. **Dependencies**
- The project uses [whisper.cpp](https://github.com/ggerganov/whisper.cpp) for transcription
- Clone and build whisper.cpp following their installation guide
- Ensure the library is properly linked in your Xcode project
- Ensure the whisper.xcframework is properly linked in your Xcode project
- Test the whisper.cpp installation independently before proceeding
3. **Building for Development**
@ -57,6 +61,6 @@ If you encounter any build issues:
2. Clean the build cache (Cmd+Shift+K twice)
3. Check Xcode and macOS versions
4. Verify all dependencies are properly installed
5. Make sure whisper.cpp is properly built and linked
5. Make sure whisper.xcframework is properly built and linked
For more help, please check the [issues](https://github.com/Beingpax/VoiceInk/issues) section or create a new issue.