From 2f92818abd102319163b9f8feec3e5f5e9d29346 Mon Sep 17 00:00:00 2001 From: abk16 Date: Sun, 17 Mar 2024 17:06:45 +0100 Subject: [PATCH] docs(README): add pipx install instructions --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9a66538..5cf9740 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,19 @@ For faster results, it is recommended to use a GPU with CUDA support. Install the latest version from the repository: ```shell pip install 'git+https://github.com/andreabak/whispersubs.git' -# or with CUDA libraries for GPU acceleration +``` +Or with CUDA libraries for GPU acceleration +```shell pip install 'whispersubs[cuda] @ git+https://github.com/andreabak/whispersubs.git' ``` +Or using pipx to install globally in an isolated environment: +```shell +pipx install 'git+https://github.com/andreabak/whispersubs.git' +``` +With pipx and CUDA libraries for GPU acceleration +```shell +pipx install 'whispersubs[cuda] @ git+https://github.com/andreabak/whispersubs.git' +``` ## Usage WhisperSubs can be used from the command line. The basic usage requires an input file, which will be the source for the transcription. The output will be a subtitle file in the SRT format in the same directory as the input file. The language will be automatically detected.