From 3879d32a392e2e37a9b9e7623a5a5cc92e19afd7 Mon Sep 17 00:00:00 2001 From: jbannon Date: Mon, 30 May 2022 19:46:37 +0000 Subject: [PATCH] update links --- README.md | 2 +- docs/getting_started.rst | 18 ++++++++++++------ 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index df4a9e35..9e390186 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,7 @@ If you are familiar with [LinuxServer.io](https://www.linuxserver.io/), you will be happy to hear that we use their base image for our docker image. Documentation on how to build the image locally can be found in the -[docker directory](https://github.com/jmbannon/ytdl-sub/tree/master/docker). +[docker readme](https://github.com/jmbannon/ytdl-sub/tree/master/docker#running-ytdl-sub-in-docker). ## Contributing diff --git a/docs/getting_started.rst b/docs/getting_started.rst index ff78131e..0d556ca3 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -41,18 +41,24 @@ If you want to jump the gun to see how ytdl-sub can be configured to do these th Install ------- -Once we are ready for our first release, we will add this package to pypi. Then, -we plan to create a docker image that uses the -`LinuxServer.io `_ -base image, and hopefully become a part of their fleet someday. -Until then, you will have to clone this repo and run it using python 3.10 +Virtualenv +__________ +With a Python 3.10 virtual environment, you can clone and install the repo using -.. code-block:: Bash +.. code-block:: shell git clone https://github.com/jmbannon/ytdl-sub.git cd ytdl-sub pip install -e . +Local Docker +____________ +If you are familiar with +`LinuxServer.io `_, +you will be happy to hear that we use their base image for our docker image. +Documentation on how to build the image locally can be found in the repo's +`docker readme `_. +