From 65593f855ffc564563c2cd9f9d7ec5d7aa10a9e8 Mon Sep 17 00:00:00 2001 From: iceberg53 Date: Wed, 31 Jan 2024 16:58:36 +0100 Subject: [PATCH] Add Visual Studio requirement for Windows in the README This commit highlights the need for Windows users to have Visual Studio including the "Desktop development with C++" workload already installed before trying to get gen-subs on their computer. Otherwise, when that requirement is not met, you get an error to node-gyp requirements on Windows. See https://github.com/nodejs/node-gyp#on-windows --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index bcfb8b4..27de3ab 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,13 @@ https://github.com/TejasQ/gen-subs/assets/9947422/bc8df523-b62a-4123-a62d-2df178 - 🎧 **Multi-modal** - Supports both audio and video files and generates subtitles for each. - 📊 **Multi-model** - Choose from a variety of machine learning models ranging from 40MB to >2GB in size. The larger the model, the more accurate the subtitles, but smaller models are also quite capable. +## Prerequisites + +### On Windows +You need to install the latest version of Visual Studio including the "Desktop development with C++" workload. This is a requirement from node-gyp which is needed for running gen-subs. + +It's available at https://visualstudio.microsoft.com/downloads + ## Usage You can generate subtitles for any video using the following command: