From 576c7db323bf2a1bbf755286b5bf771093065d85 Mon Sep 17 00:00:00 2001 From: Moss Date: Wed, 21 Dec 2022 19:42:50 -0800 Subject: [PATCH] Readme: Updated Format of Readme --- readme.md | 40 ++++++++++++++++++++++++++++------------ 1 file changed, 28 insertions(+), 12 deletions(-) diff --git a/readme.md b/readme.md index fc00ef2..41d1736 100644 --- a/readme.md +++ b/readme.md @@ -1,7 +1,14 @@ # dropout-dl -A tool to download [dropout.tv](dropout.tv) episodes. +dropout-dl is tool to download [dropout.tv](dropout.tv) episodes. It can download single episodes, seasons, or full series. +* [Installation](#installation) + * [How to Build](#how-to-build) + * [Dependencies](#Dependencies) + + + +# Installation ## How to Build ``` cmake -S -B @@ -9,12 +16,18 @@ cd make ``` -### Dependency Installation -sqlite-devel is optional with the use of the `--force-cookies` option but this is not recommended. +### Dependencies + +### Required +* [cURL](https://curl.se/libcurl/) - Required for downloading pages and videos. +### Recommended +* [SQLite](https://www.sqlite.org/index.html) - Required for retrieving cookies from browsers. This can be avoided by using the `--force-cookies` [option](#options). +### Optional +* [libgcrypt](https://www.gnupg.org/software/libgcrypt/index.html) - Used for decrypting chrome cookies retrieved from the sqlite database. #### Void ``` -sudo xbps-install -S libcurl sqlite-devel +sudo xbps-install -S libcurl sqlite-devel libgcrypt ``` #### Debian @@ -22,14 +35,6 @@ sudo xbps-install -S libcurl sqlite-devel sudo apt install libcurl4-gnutls-dev sqlite-devel ``` -## Cookies -### Firefox -Create a file named `firefox_profile` in the build directory and paste in your [firefox profile folder path](https://support.mozilla.org/en-US/kb/profiles-where-firefox-stores-user-data) -### Chrome -Install libgcrypt and create a file named `chrome_profile` in the build directory and paste in your chrome profile folder path (found on [chrome://version](chrome://version)) -### Other/No Sqlite -Use the `--force-cookies` program option to manually input cookies. - ## How to Use ``` ./dropout-dl [OPTIONS] @@ -49,12 +54,23 @@ By default, dropout-dl will download the episode in the format `/S