danvics/ytdl-sub
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

more

Browse source
This commit is contained in:
Jesse Bannon 2024-11-24 08:58:44 -08:00
parent 75c5766c94
commit 5e5b108851
1 changed files with 10 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/source/guides/getting_started/index.rst
View file

@ -1,13 +1,6 @@
Getting Started Getting Started
=============== ===============
Now that you've completed your install of ``ytdl-sub``, it's time to get started. This is a 3-step process:
- Create your subscription file
- Automate starting ytdl-sub
- (Optional) Create a custom configuration file if further customization is needed
Prerequisite Knowledge Prerequisite Knowledge
---------------------- ----------------------
@ -26,17 +19,15 @@ If you plan on using the headless image of ``ytdl-sub``, you:
Additional useful (but not required) knowledge: Additional useful (but not required) knowledge:
☑ Understanding how :yt-dlp:`\ ` works ☑ Understanding how :yt-dlp:`\ ` works
Overview
--------
Terminology Terminology
~~~~~~~~~~~ -----------
Must-know terminology: Must-know terminology:
- ``subscription``: URL(s) that you want to download with specific metadata requirements. - ``subscription``: URL(s) that you want to download with specific metadata requirements.
- ``preset``: Reusable YAML configuration, that can specify anything from metadata layout, media quality, or any feature of ytdl-sub, to apply to subscriptions. A preset can inherit other presets. - ``preset``: Reusable YAML configuration, that can specify anything from metadata layout, media quality, or any feature of ytdl-sub, to apply to subscriptions. A preset can inherit other presets.
- ``prebuilt preset``: Presets that are included in ``ytdl-sub``. These do most of the work defining plugins, overrides, etc in order to make downloads ready for player consumption. - ``prebuilt preset``: Presets that are included in ytdl-sub. These do most of the work defining plugins, overrides, etc in order to make downloads ready for player consumption.
- ``override``: Verb describing the act of overriding something in a parent preset. For example, the TV Show presets practically expect you to *override* the URL variable to tell ytdl-sub where to download from. - ``override``: Verb describing the act of overriding something in a preset. For example, the TV Show presets practically expect you to *override* the URL variable to tell ytdl-sub where to download from.
- ``override variables``: User-defined variables that are intended to *override* something. - ``override variables``: User-defined variables that are intended to *override* something.
- ``subscription file``: The file to specify all of your subscriptions and some override variables. - ``subscription file``: The file to specify all of your subscriptions and some override variables.
@ -54,6 +45,12 @@ Advanced terminology:
Ready to Start? Ready to Start?
--------------- ---------------
Now that you've completed your install of ``ytdl-sub``, it's time to get started. This is a 3-step process:
- Create your subscription file
- Automate starting ytdl-sub
- (Optional) Create a custom configuration file if further customization is needed
:doc:`Step 1: Initial Subscriptions <first_sub>` :doc:`Step 1: Initial Subscriptions <first_sub>`