From e9831eeca3bb8d1883acb31770c9348e34b82e65 Mon Sep 17 00:00:00 2001 From: getBoolean <19920697+getBoolean@users.noreply.github.com> Date: Tue, 26 Mar 2024 00:31:02 -0500 Subject: [PATCH] Add requirements file --- README.md | 11 ++++++----- requirements.txt | 1 + 2 files changed, 7 insertions(+), 5 deletions(-) create mode 100644 requirements.txt diff --git a/README.md b/README.md index aa39108..69f2855 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,15 @@ Converts an eBook folder structure to a Kavita folder structure, adding required ## Requirements -- `Python 3.11+` - `choco install python` -- [Calibre 7+](https://calibre-ebook.com/) and add the installation directory to the `PATH` environment variable -- [tqdm](https://pypi.org/project/tqdm/): `pip install tqdm` +- [Python 3.11+](https://www.python.org/downloads/) +- [Calibre 7+](https://calibre-ebook.com/) *(plus installation directory in `PATH`)* ## Usage -1. Clone this repository -1. Open Powershell to the repository directory and run the following command: +1. Install software listed in [Requirements](#requirements) +1. Clone this repository and open Powershell to the repository directory +1. Install the python dependencies: `pip install -r requirements.txt` +1. Start the script with the following command: ```bash python jln2kavita.py --src "SOURCE_DIR" --target "TARGET_DIR" diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..e9a81db --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +tqdm==4.66.2