danvics/ytdl-sub
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[DOCS] Update readme with new executable install (#474)

Browse source
This commit is contained in:
Jesse Bannon 2023-02-24 00:31:07 -08:00 committed by GitHub
parent 74ece6e185
commit a4dc61ea5b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -281,17 +281,26 @@ docker run -d \
ghcr.io/jmbannon/ytdl-sub:latest
```
### PIP
You can install our [PyPI package](https://pypi.org/project/ytdl-sub/) with:
### Executable
Download and use our latest executable using the command below. For Windows users, use this method in
[WSL](https://learn.microsoft.com/en-us/windows/wsl/). FFmpeg is a required dependency.
```commandline
python3 -m pip install -U yt-dlp
curl -L https://github.com/jmbannon/ytdl-sub/releases/latest/download/ytdl-sub > ytdl-sub
chmod +x ytdl-sub
./ytdl-sub -h
```
### PIP
You can install our [PyPI package](https://pypi.org/project/ytdl-sub/). Both FFmpeg and Python 3.10 or greater are required.
```commandline
python3 -m pip install -U ytdl-sub
```
### Building Docker Image Locally
Run `make docker` in the root directory of this repo to build the image. This
will build the python wheel and install it in the Dockerfile.
### Virtualenv
### Building Python Package Locally
With a Python 3.10 virtual environment, you can clone and install the repo using
```commandline
git clone https://github.com/jmbannon/ytdl-sub.git