From daa002e8e813c56fe9ed5fa32904e0196b1381e4 Mon Sep 17 00:00:00 2001 From: Leon Etienne <40911701+Leonetienne@users.noreply.github.com> Date: Sat, 26 Feb 2022 14:17:44 +0000 Subject: [PATCH] Update README.md --- README.md | 39 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 37 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c32a0eb..2b044c7 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,41 @@ Secondly, calling `download.sh` will invoke the two python scripts responsible f #### 3 These python scripts will invoke [yt-dlp](https://github.com/yt-dlp/yt-dlp) for each link supplied. Yt-dlp runs in download-archive mode, -which basically means it won't download a video twice. It will save it's ID and check if it's already saved before downloading. +which basically means it won't download a video twice. It will save it's video ID and check if it's already saved before downloading. -Files will be saved to `./videos//` and `./music/`. +Files will be saved to `./videos//` and `./music//`. + +## Installing / Setup +1) Clone this repository +2) Create `linklist-videos.yaml` and `linklist-music.yaml` and populate these to your linking. +3) Make sure you have Python3 and [yt-dlp](https://github.com/yt-dlp/yt-dlp) installed. +4) Done. + +# LICENSE +``` +BSD 2-Clause License + +Copyright (c) 2022, Leon Etienne +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +```