From 9320f13aa8cabdc44489de6dded5e150ae2c0dc6 Mon Sep 17 00:00:00 2001
From: Relintai <relintai@protonmail.com>
Date: Mon, 19 Sep 2022 00:26:02 +0200
Subject: [PATCH] Added a readme.md.

---
 README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3d6693f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# ytdl_link_gen
+
+A little python script that helps archiving youtube (and other) channels using yt-dlp.
+
+## Features
+
+- Generates a simple batch file that you can use to get everything.
+- Skips downloading all video metadata, unlike vanilla yt-dlp.
+- Keeps track the videos you have without needing to keep the videos accessible, and only dowloads missing stuff.
+- Numbers each video, also remembers old numbering (meaning: deleted videos will not screw up video numbering).
+- Backs up it's data before an update.
+
+## Usage
+
+First make sure that you have python 3 installed.
+
+Install yt-dlp:
+
+` sudo pip install yt-dlp  `
+
+Set up your config file:
+
+` cp config.txt.example config.txt `
+
+Add all channels that you want to grab to your new config.txt.
+
+Run the script:
+
+` python ytdl_link_gen.py `
+
+If you run into any issue you can safely run the script again, it will continue where it left off.
+
+Once this is finished you can (and should, if you want to update videos again) delete the new temp directory. It contains channel data,
+so if an error occurs it won't have to re-download channel lists again.
+
+You should have a ` dl.sh ` now. Containing yt-dlp commands to all videos since the previous run.
+
+Run it single threaded:
+
+``` 
+chmod +x dl.sh 
+./dl.sh
+```
+
+Or for example using parallel:
+
+` parallel -j4 -a dl.sh --progress `
+
+### Note
+
+If you get an error conplaining about a null object being unindexable check the .json for that channel in the temp directory.
+if it only has a null in in delete it. That should solve the issue.