Skip to content

Commit

Permalink
docs: add BYOL to README
Browse files Browse the repository at this point in the history
  • Loading branch information
JacobLinCool committed Jan 15, 2024
1 parent 5ae767d commit 1c723a8
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,28 @@ Smart-Whisper is a native Node.js addon designed for efficient and streamlined i

## Installation

The standard installation supports Windows, macOS, and Linux out of the box. And it also automatically enables the GPU and CPU acceleration on macOS.

```sh
npm i smart-whisper
```

### Acceleration

Due to the complexity of the different acceleration methods for different devices. You need to compile the `libwhisper.a` or `libwhisper.so` from [whisper.cpp](https://github.com/ggerganov/whisper.cpp) yourself.

And then set the `BYOL` (Bring Your Own Library) environment variable to the path of the compiled library.

```sh
BYOL='/path/to/libwhisper.a' npm i smart-whisper
```

You may need to link other libraries like:

```sh
BYOL='/path/to/libwhisper.a -lopenblas' npm i smart-whisper
```

## Documentation

The documentation is available at <https://jacoblincool.github.io/smart-whisper/>.
Expand Down

0 comments on commit 1c723a8

Please sign in to comment.