Skip to content

Commit 91d92d1

Browse files
Update Readme
1 parent fc7002e commit 91d92d1

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

README.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ Fetch youtube url from your subscription
1515
```
1616
make -j$(nproc)
1717
```
18+
- run ./ytwatch
19+
20+
Alternative build the appimage with the script:
21+
```
22+
./build_appimage.sh
23+
```
1824

1925
# USAGE
2026

@@ -25,25 +31,28 @@ Fetch youtube url from your subscription
2531
- Click on "Next step" and then on "Create export"
2632
- Click on the "Download" button after it appears
2733
- From the downloaded zip extract the .csv in the subscriptions folder
28-
- Run the application passing the csv (or save the csv in the default path ```XDG_CONFIG_HOME/ytwatch/subscriptions.csv```)
34+
- Save the csv in the default path ```XDG_CONFIG_HOME/ytwatch/subscriptions.csv``` or specify a path with the environment variable
2935

30-
```ytwatch [-p] subscriptions.csv```
36+
```ytwatch [-p] {channel name}```
3137

3238
# Dependency
3339

3440
* curl
3541
* fzf
3642
* ueberzug
3743
* fmt
44+
* devour (optional)
3845

3946
# Configuration
4047

4148
Ytwatch script use the current env variable
4249

43-
| ENV | DESCRIPTION |
44-
|-------------------------|-------------------------------------------------------|
45-
|YTWATCH_SUBSCRIPTIONS_CSV|CSV subscriptions path |
46-
|YTWATCH_PLAYER |Video player (mpv default) |
47-
|YTWATCH_PLAYER_OPT |Video player options |
48-
|YTWATCH_SWALLOWER |Swallow program (empty string for none, default devour)|
49-
|YTWATCH_SCRAPER |Ytscraper path (current dir by default) |
50+
|Environment Variable|Description|Default Value
51+
---------------------|-----------|------------
52+
|YTWATCH_SUBSCRIPTIONS_CSV|Path to the subscriptions CSV file|$XDG_CONFIG_HOME/ytwatch/subscriptions.csv
53+
|YTWATCH_PLAYER|Video player|mpv
54+
|YTWATCH_PLAYER_OPT|Video player options|"--playlist=-"
55+
|YTWATCH_SWALLOWER|Swallowed program| devour
56+
|YTWATCH_SCRAPER|Ytscraper path| "./ytscraper"
57+
|YTWATCH_UEBERZUGPP|Path to UeberzugPP binary| /usr/local/bin/ueberzugpp
58+
|YTWATCH_FZF|Path to FZF binary| fzf

0 commit comments

Comments
 (0)