Skip to content

Commit 4244005

Browse files
committed
Add instraction for build options in README
1 parent 46bdf92 commit 4244005

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

bindings/ruby/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,16 @@ If bundler is not being used to manage dependencies, install the gem by executin
1616

1717
$ gem install whispercpp
1818

19+
You can pass build options for whisper.cpp, for instance:
20+
21+
$ bundle config build.whispercpp --enable-ggml-cuda
22+
23+
$ gem install whispercpp -- --enable-ggml-cuda
24+
25+
See whisper.cpp's [README](https://github.com/ggml-org/whisper.cpp/blob/master/README.md) for available options. You need convert options present the README to Ruby-style options.
26+
For boolean options like `GGML_CUDA`, the README says `-DGGML_CUDA=1`. You need strip `-D`, prepend `--enable-` for `1` or `ON` (`--disable-` for `0` or `OFF`) and make it kebab-case: `--enable-ggml-cuda`.
27+
For options which require arguments like `CMAKE_CUDA_ARCHITECTURES`, the README says `-DCMAKE_CUDA_ARCHITECTURES="86"`. You need strip `-D`, prepend `--`, make it kebab-case, append `=` and append argument: `--cmake-cuda-architectures="86"`.
28+
1929
Usage
2030
-----
2131

0 commit comments

Comments
 (0)