Skip to content

Commit 3c38e16

Browse files
committed
docs: add Windows installation instructions to README
1 parent 7e9a2c2 commit 3c38e16

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,24 @@ sudo apt install build-essential
3737

3838
- NOTE: user may need to install make tool
3939

40+
### Windows Installation
41+
42+
1. Install MinGW-w64 or MSYS2 (which includes make tools)
43+
- Option 1: Install MSYS2 from https://www.msys2.org/
44+
- Option 2: Install MinGW-w64 from https://www.mingw-w64.org/
45+
46+
2. Install nodejs-whisper with npm
47+
```bash
48+
npm i nodejs-whisper
49+
```
50+
51+
3. Download whisper model
52+
```bash
53+
npx nodejs-whisper download
54+
```
55+
56+
- Note: Make sure mingw32-make or make is available in your system PATH.
57+
4058
## Usage/Examples
4159

4260
See `example/index.ts` (can be run with `$ npm run test`)

0 commit comments

Comments
 (0)