github/television
1
1
Fork 0
mirror of https://github.com/alexpasmantier/television.git synced 2025-07-29 06:11:37 +00:00
Code Issues 1 Packages Projects Releases Wiki Activity

docs: add link to shell integration local dev note

Browse Source
This commit is contained in:
alexandre pasmantier 2025-07-12 21:10:34 +02:00
parent 7079d48aa7
commit 1bbda8e62f
2 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/02-Developers/04-shell-integration-developing-locally.md Normal file
View File

@ -0,0 +1,16 @@
# Shell Integration: Developing locally
In order to develop locally on the shell integration scripts, here are a couple of steps to follow:
0. Clone the repo, make sure you're up to date and have the [just](https://github.com/casey/just) command runner installed.
1. Make your changes to any one of the shell scripts (`television/utils/shell/`)
2. Generate a dev version of the script by running:
```sh
just generate-dev-shell-integration zsh
```
(or `fish`, `bash`, etc. depending on the shell you are using)
3. Source the generated script in your shell:
```sh
source dev_shell_integration.zsh
```
4. Test the changes by using the shell integration keybindings or commands in your terminal.

2
television/utils/shell/README.md
View File

@ -1,4 +1,4 @@
# Developing locally
# Shell Integration: Developing locally
In order to develop locally on the shell integration scripts, here are a couple of steps to follow: