Skip to content

Commit

Permalink
docs(README): add pipx install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
andreabak committed Mar 17, 2024
1 parent 6feb7cb commit 1757776
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
```
Or 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.
Expand Down

0 comments on commit 1757776

Please sign in to comment.