7f26c4e988
This is an ongoing project to revamp the YTDL-Sub docs. Starting point: - Recreate docs folder/file structure - Update root makefile to use new make docs command - Move old docs into new docs folder structure (as a base) - Separate out old docs into individual files to allow better navigation with the new theme
35 lines
No EOL
766 B
ReStructuredText
35 lines
No EOL
766 B
ReStructuredText
Environment Agnostic
|
|
====================
|
|
|
|
PIP Install
|
|
--------------
|
|
You can install our
|
|
`PyPI package <https://pypi.org/project/ytdl-sub/>`_.
|
|
Both ffmpeg and Python 3.10 or greater are required.
|
|
|
|
.. code-block:: bash
|
|
|
|
python3 -m pip install -U ytdl-sub
|
|
|
|
Local Install
|
|
--------------
|
|
With a Python 3.10 virtual environment, you can clone and install the repo.
|
|
|
|
.. code-block:: bash
|
|
|
|
git clone https://github.com/jmbannon/ytdl-sub.git
|
|
cd ytdl-sub
|
|
|
|
pip install -e .
|
|
|
|
Local Docker Build
|
|
-------------------
|
|
Run ``make docker`` in the root directory of this repo to build the image. This
|
|
will build the python wheel and install it in the Dockerfile.
|
|
|
|
.. code-block:: bash
|
|
|
|
git clone https://github.com/jmbannon/ytdl-sub.git
|
|
cd ytdl-sub
|
|
|
|
make docker |