mirror of
https://github.com/ihabunek/twitch-dl
synced 2024-08-30 18:32:25 +00:00
Add docs and changelog
This commit is contained in:
parent
24eb163d98
commit
52a7191d1f
@ -17,7 +17,7 @@ Resources
|
|||||||
Requirements
|
Requirements
|
||||||
------------
|
------------
|
||||||
|
|
||||||
* Python 3.7 or later
|
* Python 3.8 or later
|
||||||
* [ffmpeg](https://ffmpeg.org/download.html), installed and on the system path
|
* [ffmpeg](https://ffmpeg.org/download.html), installed and on the system path
|
||||||
|
|
||||||
Quick start
|
Quick start
|
||||||
|
@ -1,3 +1,10 @@
|
|||||||
|
3.0.0:
|
||||||
|
date: TBA
|
||||||
|
changes:
|
||||||
|
- "BREAKING: Requires python 3.8 or later"
|
||||||
|
- "Migrated to click lib for cli parsing"
|
||||||
|
- "Add shell auto completion"
|
||||||
|
|
||||||
2.1.4:
|
2.1.4:
|
||||||
date: 2024-01-06
|
date: 2024-01-06
|
||||||
changes:
|
changes:
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Installation
|
# Installation
|
||||||
|
|
||||||
twitch-dl requires **Python 3.7** or later.
|
twitch-dl requires **Python 3.8** or later.
|
||||||
|
|
||||||
## Prerequisite: FFmpeg
|
## Prerequisite: FFmpeg
|
||||||
|
|
||||||
|
31
docs/shell_completion.md
Normal file
31
docs/shell_completion.md
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
# Shell completion
|
||||||
|
|
||||||
|
> Introduced in twitch-dl 3.0.0
|
||||||
|
|
||||||
|
twitch-dl uses [Click shell completion](https://click.palletsprojects.com/en/8.1.x/shell-completion/) which works on Bash, Fish and Zsh.
|
||||||
|
|
||||||
|
To enable completion, twitch-dl must be [installed](./installation.html) as a command and available by ivoking `twitch-dl`. Then follow the instructions for your shell.
|
||||||
|
|
||||||
|
**Bash**
|
||||||
|
|
||||||
|
Add to `~/.bashrc`:
|
||||||
|
|
||||||
|
```
|
||||||
|
eval "$(_TWITCH_DL_COMPLETE=bash_source twitch-dl)"
|
||||||
|
```
|
||||||
|
|
||||||
|
**Fish**
|
||||||
|
|
||||||
|
Add to `~/.config/fish/completions/twitch-dl.fish`:
|
||||||
|
|
||||||
|
```
|
||||||
|
_TWITCH_DL_COMPLETE=fish_source twitch-dl | source
|
||||||
|
```
|
||||||
|
|
||||||
|
**Zsh**
|
||||||
|
|
||||||
|
Add to `~/.zshrc`:
|
||||||
|
|
||||||
|
```
|
||||||
|
eval "$(_TWITCH_DL_COMPLETE=zsh_source twitch-dl)"
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user