From 9ac6e7dd6df70a8697e501caac0ad6f48f1a0332 Mon Sep 17 00:00:00 2001 From: Jesse Bannon Date: Sat, 17 Feb 2024 08:43:14 -0800 Subject: [PATCH] cleanup --- docs/source/guides/getting_started/index.rst | 36 ++++++++++++++------ 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/docs/source/guides/getting_started/index.rst b/docs/source/guides/getting_started/index.rst index c503a5ad..3aa856bc 100644 --- a/docs/source/guides/getting_started/index.rst +++ b/docs/source/guides/getting_started/index.rst @@ -29,28 +29,44 @@ If you plan on using the headless image of ``ytdl-sub``, you: Additional useful (but not required) knowledge: ☑ Understanding how :yt-dlp:`\ ` works - -Quick Overview of ``ytdl-sub`` ------------------------------- - +Overview +-------- ``ytdl-sub`` uses two types of YAML files: -- ``config.yaml`` defines ``presets``, which are the "definitions" of your media. ``presets`` "define" how you want your media downloaded, which formats, naming conventions to follow when saving them, etc. These ``presets`` can also inherit other ``presets``, so that you can easily modify an existing ``preset``. -- ``subscriptions.yaml`` defines ``subscriptions``, which specify the media we want to recurrently download, like YouTube channels and playlists, SoundCloud artists, or any :yt-dlp:`yt-dlp supported site `. ``subscriptions`` use ``presets`` to define how ``ytdl-sub`` should handle downloading, processing, and saving them. +subscriptions.yaml +~~~~~~~~~~~~~~~~~~ +Defines ``subscriptions``, which specify the media we want to recurrently download, like YouTube +channels and playlists, SoundCloud artists, or any +:yt-dlp:`yt-dlp supported site `. ``subscriptions`` use ``presets`` +to define how ``ytdl-sub`` should handle downloading, processing, and saving them. -When ``ytdl-sub`` is run, in its most basic form: +``ytdl-sub`` comes packaged with many +:ref:`prebuilt presets ` +that will play nicely with well-known media players. + +config.yaml +~~~~~~~~~~~ +To customize ``ytdl-sub`` to beyond the prebuilt presets, you will need a ``config.yaml`` file. This +file is where custom ``presets`` can be defined to orchestrate ``ytdl-sub`` to your very specific needs. + +Running ytdl-sub +~~~~~~~~~~~~~~~~ +To invoke ``ytdl-sub`` to download subscriptions, use the following command: .. tab-set-code:: .. code-block:: shell - ytdl-sub sub + ytdl-sub sub subscriptions.yaml .. code-block:: powershell - ytdl-sub.exe sub + ytdl-sub.exe sub subscriptions.yaml -``ytdl-sub`` initially downloads all files to a defined ``working_directory``. This is a temporary storage spot for metadata and media files so that errors during processing- if they occur- don't affect your existing media library. Once all file processing is complete, your media files are moved to the ``output_directory``. +``ytdl-sub`` initially downloads all files to a defined ``working_directory``. This is a temporary +storage spot for metadata and media files so that errors during processing- if they occur- don't +affect your existing media library. Once all file processing is complete, your media files are +moved to the ``output_directory``. Ready to Start? ---------------