From 018c5b542bafdef724ede5bc38a4f7cc8a1c5d6f Mon Sep 17 00:00:00 2001 From: santiagosayshey Date: Sun, 10 Mar 2024 03:36:40 +1030 Subject: [PATCH] Update README.md --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a8e68dc..e520231 100644 --- a/README.md +++ b/README.md @@ -22,15 +22,16 @@ Come join us at https://discord.gg/ZxywYBGRB9 if you need any help or want to ta 1. Download the latest Profilarr package from the release section. 2. Extract its contents into a folder. -3. Run `pip install -r requirements.txt` to install dependencies. -4. Run `python setup.py` in your command line interface to generate a config file. - - This will create a `config.yml` file in the same directory as `setup.py`. -5. Open the `config.yml` file in a text editor. +3. Navigate to this extracted folder inside your terminal using `cd` +4. Run `pip install -r requirements.txt` to install dependencies. +5. Run `python setup.py` in your command line interface to generate a config file. + - This will create a `config.yml` file. +6. Open the `config.yml` file in a text editor. - Add the URL and API key to the master instances of Radarr / Sonarr. - If syncing, add the URL, API key, and a name to each extra instance of Radarr / Sonarr. - If exporting, adjust the `export_path` to your desired export location. - If importing non-Dictionary files, adjust the `import_path` to your desired import location. -6. Configure ANSI Color Support (Optional): +7. Configure ANSI Color Support (Optional): - The Profilarr scripts use ANSI colors in terminal output for better readability. By default, this feature is enabled (`ansi_colors: true`). - **If your terminal does not properly display ANSI colors** (e.g., you see codes like `←[94m` instead of colored text), you may want to disable this feature to improve readability. - To disable ANSI colors, find the `settings` section in your `config.yml` file and change `ansi_colors` to `false`. @@ -40,7 +41,7 @@ Come join us at https://discord.gg/ZxywYBGRB9 if you need any help or want to ta import_path: "./imports" ansi_colors: false # Disable ANSI colors if your terminal doesn't support them ``` -7. Save the changes to your `config.yml` file after making the necessary adjustments. +8. Save the changes to your `config.yml` file after making the necessary adjustments. ## 🚀 Usage