From 1cacdcb8a9611940bf4608053a750fa9025d9d1a Mon Sep 17 00:00:00 2001 From: Luther Schallot <8540622+LSchallot@users.noreply.github.com> Date: Tue, 2 Mar 2021 22:16:48 -0600 Subject: [PATCH 1/6] Updating README.md with new Windows installation instrucions. --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e817392..0c567e0 100644 --- a/README.md +++ b/README.md @@ -43,11 +43,28 @@ Download the latest [release](https://github.com/TheFrenchGhosty/TheFrenchGhosty ## Installation (Windows): -Setup Windows Subsystem for Linux (WSL) and follow the Linux installation. +### Known Issues +* Windows has a hard limit of 260 characters for the filepath. This can cause issues with video downloading. It is recommended that you make your filepath as short as possible. +* If you are receiving a permission denied error when attempting to execute python, [this thread](https://stackoverflow.com/questions/56974927/permission-denied-trying-to-run-python-on-windows-10) may be helpful. +* yt-dlp must be named "yt-dlp.exe". This means if you down the x86 version, you will need to rename it or create a symlink. -Detailed setup instruction need to be added to the documentation. +### Required Software +In order to run these scripts, the following software packages must be installed: -Why: Because Windows is using a path length limit of 260 characters, and because of the work required (and the fact that the Windows version was untested when it existed), Windows users needs to use the scripts in WSL. WSL bypass the path length limit so every video will get downloaded, however when playing it with a native Windows software the path length issue might be an issue, I can't do anything about that. +* [Cygwin](https://www.cygwin.com/), [Git Bash](http://git-scm.com), or some other application that enables Bash functionality in Windows. +* [Python 3](https://www.python.org/downloads/) +* [yt-dlp](https://github.com/pukkandan/yt-dlp) - Make sure this is in your PATH. +* [ffmpeg](https://www.ffmpeg.org/) - Make sure this is in your PATH. +* [atomicparsley](https://github.com/wez/atomicparsley) (optional) + +### Configuration +First, make sure that all dependencies are installed and your PATH is configured properly by opening your Bash terminal of choice and executing the following: + +* `python --version` +* `yt-dlp --version` +* `ffmpeg --version` + +If all of the above commands execute correctly, download the latest [release](https://github.com/TheFrenchGhosty/TheFrenchGhostys-YouTube-DL-Archivist-Scripts/releases) and follow the "Usage" section of this README. --- From e531f531daf559356ad334d0b07f397c3ba09282 Mon Sep 17 00:00:00 2001 From: TheFrenchGhosty <47571719+TheFrenchGhosty@users.noreply.github.com> Date: Wed, 3 Mar 2021 19:51:39 +0000 Subject: [PATCH 2/6] Make some change to allow someone to add WSL instruction --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0c567e0..0adb342 100644 --- a/README.md +++ b/README.md @@ -43,12 +43,18 @@ Download the latest [release](https://github.com/TheFrenchGhosty/TheFrenchGhosty ## Installation (Windows): -### Known Issues +### Installation using WSL (recommended): + +TODO + +### Installation using Cygwin, Git Bash or similar; + +#### Known Issues * Windows has a hard limit of 260 characters for the filepath. This can cause issues with video downloading. It is recommended that you make your filepath as short as possible. * If you are receiving a permission denied error when attempting to execute python, [this thread](https://stackoverflow.com/questions/56974927/permission-denied-trying-to-run-python-on-windows-10) may be helpful. * yt-dlp must be named "yt-dlp.exe". This means if you down the x86 version, you will need to rename it or create a symlink. -### Required Software +#### Required Software In order to run these scripts, the following software packages must be installed: * [Cygwin](https://www.cygwin.com/), [Git Bash](http://git-scm.com), or some other application that enables Bash functionality in Windows. @@ -57,7 +63,7 @@ In order to run these scripts, the following software packages must be installed * [ffmpeg](https://www.ffmpeg.org/) - Make sure this is in your PATH. * [atomicparsley](https://github.com/wez/atomicparsley) (optional) -### Configuration +#### Configuration First, make sure that all dependencies are installed and your PATH is configured properly by opening your Bash terminal of choice and executing the following: * `python --version` From e697c7a2082a97c34f810d20339b8ba67db31f69 Mon Sep 17 00:00:00 2001 From: TheFrenchGhosty <47571719+TheFrenchGhosty@users.noreply.github.com> Date: Wed, 3 Mar 2021 19:54:00 +0000 Subject: [PATCH 3/6] Enhance some stuff, remove the line about yt-dlp.exe since it's not applicable --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0adb342..9c8f64b 100644 --- a/README.md +++ b/README.md @@ -47,12 +47,11 @@ Download the latest [release](https://github.com/TheFrenchGhosty/TheFrenchGhosty TODO -### Installation using Cygwin, Git Bash or similar; +### Installation using Cygwin, Git Bash or similar: #### Known Issues -* Windows has a hard limit of 260 characters for the filepath. This can cause issues with video downloading. It is recommended that you make your filepath as short as possible. +* Windows has a hard limit of 260 characters for the filepath. This can cause issues with video downloading. It is recommended that you make your filepath as short as possible. * If you are receiving a permission denied error when attempting to execute python, [this thread](https://stackoverflow.com/questions/56974927/permission-denied-trying-to-run-python-on-windows-10) may be helpful. -* yt-dlp must be named "yt-dlp.exe". This means if you down the x86 version, you will need to rename it or create a symlink. #### Required Software In order to run these scripts, the following software packages must be installed: @@ -61,7 +60,7 @@ In order to run these scripts, the following software packages must be installed * [Python 3](https://www.python.org/downloads/) * [yt-dlp](https://github.com/pukkandan/yt-dlp) - Make sure this is in your PATH. * [ffmpeg](https://www.ffmpeg.org/) - Make sure this is in your PATH. -* [atomicparsley](https://github.com/wez/atomicparsley) (optional) +* [atomicparsley](https://github.com/wez/atomicparsley) (optional) - Make sure this is in your PATH. #### Configuration First, make sure that all dependencies are installed and your PATH is configured properly by opening your Bash terminal of choice and executing the following: From e8d79e2a0a378bd41ed74f484cc5d4659773349f Mon Sep 17 00:00:00 2001 From: TheFrenchGhosty <47571719+TheFrenchGhosty@users.noreply.github.com> Date: Wed, 3 Mar 2021 19:55:51 +0000 Subject: [PATCH 4/6] Move the Cygwin/Git Bash instruction to a dedicated documentation file --- docs/Cygwin-Git-Bash.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 docs/Cygwin-Git-Bash.md diff --git a/docs/Cygwin-Git-Bash.md b/docs/Cygwin-Git-Bash.md new file mode 100644 index 0000000..db218e0 --- /dev/null +++ b/docs/Cygwin-Git-Bash.md @@ -0,0 +1,23 @@ +### Installation using Cygwin, Git Bash or similar: + +#### Known Issues +* Windows has a hard limit of 260 characters for the filepath. This can cause issues with video downloading. It is recommended that you make your filepath as short as possible. +* If you are receiving a permission denied error when attempting to execute python, [this thread](https://stackoverflow.com/questions/56974927/permission-denied-trying-to-run-python-on-windows-10) may be helpful. + +#### Required Software +In order to run these scripts, the following software packages must be installed: + +* [Cygwin](https://www.cygwin.com/), [Git Bash](http://git-scm.com), or some other application that enables Bash functionality in Windows. +* [Python 3](https://www.python.org/downloads/) +* [yt-dlp](https://github.com/pukkandan/yt-dlp) - Make sure this is in your PATH. +* [ffmpeg](https://www.ffmpeg.org/) - Make sure this is in your PATH. +* [atomicparsley](https://github.com/wez/atomicparsley) (optional) - Make sure this is in your PATH. + +#### Configuration +First, make sure that all dependencies are installed and your PATH is configured properly by opening your Bash terminal of choice and executing the following: + +* `python --version` +* `yt-dlp --version` +* `ffmpeg --version` + +If all of the above commands execute correctly, download the latest [release](https://github.com/TheFrenchGhosty/TheFrenchGhostys-YouTube-DL-Archivist-Scripts/releases) and follow the "Usage" section of this README. From fbe1c5bc7668f2732663795cda0fa5c62c866811 Mon Sep 17 00:00:00 2001 From: TheFrenchGhosty <47571719+TheFrenchGhosty@users.noreply.github.com> Date: Wed, 3 Mar 2021 19:57:00 +0000 Subject: [PATCH 5/6] Remove the Cygwin/Git Bash instruction from the README --- README.md | 28 ++-------------------------- 1 file changed, 2 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 9c8f64b..7ce4e06 100644 --- a/README.md +++ b/README.md @@ -43,33 +43,9 @@ Download the latest [release](https://github.com/TheFrenchGhosty/TheFrenchGhosty ## Installation (Windows): -### Installation using WSL (recommended): +### Installation using WSL (recommended): TODO -TODO - -### Installation using Cygwin, Git Bash or similar: - -#### Known Issues -* Windows has a hard limit of 260 characters for the filepath. This can cause issues with video downloading. It is recommended that you make your filepath as short as possible. -* If you are receiving a permission denied error when attempting to execute python, [this thread](https://stackoverflow.com/questions/56974927/permission-denied-trying-to-run-python-on-windows-10) may be helpful. - -#### Required Software -In order to run these scripts, the following software packages must be installed: - -* [Cygwin](https://www.cygwin.com/), [Git Bash](http://git-scm.com), or some other application that enables Bash functionality in Windows. -* [Python 3](https://www.python.org/downloads/) -* [yt-dlp](https://github.com/pukkandan/yt-dlp) - Make sure this is in your PATH. -* [ffmpeg](https://www.ffmpeg.org/) - Make sure this is in your PATH. -* [atomicparsley](https://github.com/wez/atomicparsley) (optional) - Make sure this is in your PATH. - -#### Configuration -First, make sure that all dependencies are installed and your PATH is configured properly by opening your Bash terminal of choice and executing the following: - -* `python --version` -* `yt-dlp --version` -* `ffmpeg --version` - -If all of the above commands execute correctly, download the latest [release](https://github.com/TheFrenchGhosty/TheFrenchGhostys-YouTube-DL-Archivist-Scripts/releases) and follow the "Usage" section of this README. +### Installation using Cygwin, Git Bash or similar: [Here](docs/Cygwin-Git-Bash.md) --- From 4c9fa52cd104946822230c78985e51c1e0d24bc9 Mon Sep 17 00:00:00 2001 From: TheFrenchGhosty <47571719+TheFrenchGhosty@users.noreply.github.com> Date: Wed, 3 Mar 2021 19:58:37 +0000 Subject: [PATCH 6/6] Change some stuff, restore something that was deleted --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7ce4e06..007d2c5 100644 --- a/README.md +++ b/README.md @@ -43,9 +43,10 @@ Download the latest [release](https://github.com/TheFrenchGhosty/TheFrenchGhosty ## Installation (Windows): -### Installation using WSL (recommended): TODO +Installation using WSL (recommended): TODO -### Installation using Cygwin, Git Bash or similar: [Here](docs/Cygwin-Git-Bash.md) + +Installation using Cygwin, Git Bash or similar: [Here](docs/Cygwin-Git-Bash.md) ---