github/StreamingCommunity
1
1
Fork 0
mirror of https://github.com/Arrowar/StreamingCommunity.git synced 2025-06-07 20:15:24 +00:00
Code Issues 2 Packages Projects Releases Wiki Activity

style(readme): improve clarity (#70)

Browse Source 
* Improve clarity

Chiarisce alcune differenze tra Windows e sistemi Unix, e altri minor changes

* Improve clarity

Chiarisce alcune differenze tra Windows e sistemi Unix, e altri minor changes
This commit is contained in:
Cohvir 2024-03-07 13:34:38 +01:00 committed by GitHub
parent ce2408ad00
commit 3363c00f21
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 22 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -18,21 +18,32 @@ Make sure you have the following prerequisites installed on your system:
## Installation library ## Installation library
Install the required Python libraries using the following command: Install the required Python libraries using the following command:
```bash ```
pip install -r requirements.txt pip install -r requirements.txt
``` ```
## Usage ## Usage
Run the script with the following command: Run the script with the following command:
#### On Windows:
```powershell ```powershell
python run.py python run.py
``` ```
#### On Linux/MacOS:
```bash
python3 run.py
```
## Auto Update ## Auto Update
Keep your script up to date with the latest features by running: Keep your script up to date with the latest features by running:
#### On Windows:
```powershell ```powershell
python update.py python update.py
``` ```
#### On Linux/MacOS:
```bash
python3 update.py
```
## Features ## Features
- Download Single Film: Easily download individual movies with a simple command. - Download Single Film: Easily download individual movies with a simple command.
@ -60,17 +71,17 @@ You can change some behaviors by tweaking the configuration file.
``` ```
#### Options #### Options
| Key | Default Value | Description | Value Example | | Key | Default Value | Description | Value Example |
|---------------------------|---------------|------------------------------------------------------------------------------------------|--------------------------| |---------------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------|--------------------------|
| root_path | videos | *Path where the script will add movies and tv series folders. Do not put trailing slash. | media/streamingcommunity | | root_path | videos | Path where the script will add movies and tv series folders (see [Path Examples](#Path-examples)). Do not put trailing slash. | media/streamingcommunity |
| movies_folder_name | Movies | The folder name where all the movies will be placed. Do not put trailing slash. | downloaded-movies | | movies_folder_name | Movies | The folder name where all the movies will be placed. Do not put trailing slash. | downloaded-movies |
| series_folder_name | Series | The folder name where all the TV Series will be placed. Do not put trailing slash. | mytvseries | | series_folder_name | Series | The folder name where all the TV Series will be placed. Do not put trailing slash. | mytvseries |
| download_subtitles | true | Whether or not you want all the found subtitles to be downloaded. | false | | download_subtitles | true | Whether or not you want all the found subtitles to be downloaded. | false |
| download_default_language | true | Whether or not you want to download only the default Italian audio language. | false | | download_default_language | true | Whether or not you want to download only the default Italian audio language. | false |
| selected_language | English | If `"download_default_language"` is `False` the script will download this language | French | | selected_language | English | If `"download_default_language"` is `False` the script will download this language. | French |
| max_worker | 20 | How many workers will cooperate to download .ts file (High value may slow down your pc) | 30 | | max_worker | 20 | How many workers will cooperate to download .ts file. **High value may slow down your pc**. | 30 |
> [!IMPORTANT] > [!IMPORTANT]
> If you're on **Windows** you'll need to use double black slashes. Otherwise, one slash is fine. > If you're on **Windows** you'll need to use double black slashes. On Linux/MacOS, one slash is fine.
#### Path examples: #### Path examples: