diff --git a/readme.md b/readme.md index 533bada..895780e 100644 --- a/readme.md +++ b/readme.md @@ -57,8 +57,9 @@ Requirements The following command-line tools must be installed on your system and accessible in your system's PATH for the application to function. +```sh apt install git ffmpeg yt-dlp python3-tk tesseract-ocr libtesseract-dev tesseract-ocr-en - +``` Git: (Optional) Required for using the self-updating feature from the GUI's "About" menu. 2. Python Dependencies @@ -72,42 +73,34 @@ The script requires Python 3.7+ and several third-party libraries. You can insta ## Installation - Clone the repository to your local machine: - code Bash - - +- Clone the repository to your local machine: +``` git clone https://github.com/peterpt/iptv-check.git cd iptv-check - +``` +- Install the required Python3 libraries using pip: +``` +pip install -r requirements.txt +``` +Ensure all External Dependencies are installed correctly and that their locations are in your system's PATH. - - Install the required Python3 libraries using pip: - - - pip install -r requirements.txt - - Ensure all External Dependencies are installed correctly and that their locations are in your system's PATH. - -Usage -GUI Mode (Recommended) +## Usage +### GUI Mode (Recommended) For the best and most user-friendly experience, run the application with the --gui flag. -code Bash - - +```sh python3 iptv_check.py --gui - - +``` The graphical interface provides easy access to all features, including the Website Finder and Links Database. Tooltips are available for all major options to guide you. -Command-Line (CLI) Mode + +### Command-Line (CLI) Mode For automation, scripting, or use in a server environment, the CLI provides full access to the core checking functionality. Basic Examples: -code Bash - - +```sh # Check a remote URL and save working streams to updated.m3u python3 iptv_check.py -f "http://example.com/playlist.m3u" @@ -120,20 +113,19 @@ python3 iptv_check.py -r "my_checked_list.m3u" # Check all playlists stored in your personal links database python3 iptv_check.py -d - +``` -Advanced Example: +#### Advanced Example: +```sh # Use 20 workers, a 10-second timeout, and enable OCR checking for the highest quality results python3 iptv_check.py -f "playlist.m3u" -w 20 -t 10 --ocr - +``` -All CLI Arguments: -code Code - - --h, --help Show the help message and exit. +### All CLI Arguments: +``` + -h, --help Show the help message and exit. -gui, --gui Launch the graphical user interface. CLI Input Options (choose one): @@ -153,10 +145,10 @@ CLI General Options: Log output format for the CLI (default: name). --ocr Enable OCR checking for video streams. --no-skip Disable skipping of known good URLs. - +``` -Configuration +### Configuration The application will automatically create the following configuration files in its directory on the first run: @@ -164,15 +156,14 @@ The application will automatically create the following configuration files in i iptv_checker_links.ini: Stores the URLs for the Links Database feature. -## Old versions can be downloaed in : +### Old versions can be downloaed in : https://github.com/peterpt/IPTV-CHECK/releases -License +### License This project is licensed under the MIT License. -Credits +### Credits Project Leader & Creator: peterpt - Code Assistance by: Gemini Pro Model