aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorPinapelz <donaldshan1@outlook.com>2024-10-09 00:01:31 -0700
committerGitHub <noreply@github.com>2024-10-09 00:01:31 -0700
commit866a8b7d1bc47999e5846c6402e45473bdd1114f (patch)
tree809117a42ca5adb873e61cf553a54769a0f89dfb /README.md
parent012bafb44a9f9f502e747f434fc516dc29fc417b (diff)
Update README.md with rquirements and usage instructions
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md
index 246a1ef..01a3cf0 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ A GUI wrapper for yt-dlp that downloads YouTube videos to MP3 and automatically
###
![image](https://user-images.githubusercontent.com/21994085/199175477-b2d6d5ae-d7db-455c-813f-ad1d3af7fac5.png)
-
+# Manual
If you don't want to use the built-in GUI builder to create a "task file", you can write it manually in your file of choice
Each line will be treated as a download job (video), you may use either the full `youtube.com` or shortened `youtu.be` link
@@ -20,3 +20,15 @@ URL,START_TIME-END_TIME (HH:MM:SS Timestamp Format)
ex: `https://www.youtube.com/watch?v=qvj_QSqOrBw,00:01:10-00:01:40`
- Download video `https://www.youtube.com/watch?v=qvj_QSqOrBw` from `1 min 10s` to `1 min 40s` (30s total)
+
+
+# Requirements
+The packages/programs below must be accessible from any path. (If you are on Windows these will need to be in your PATH environment variable)
+- ffmpeg
+- yt-dlp
+- Java
+
+# Binaries
+Pre-built binaries are also available. You can download it from the [Releases](https://github.com/pinapelz/ytID3AutoTag/releases) section
+
+You can either run it like an application or for a debug log run it as `java -jar ytID3AutoTag.jar` from the terminal
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage