Commit Graph

88 Commits

Author SHA1 Message Date
oop7 a512c603ce Document playlist export and new defaults
Update README to reflect new features and settings: add "Export Playlists" to the feature table; document the "Save Playlist As" export options (.txt, .csv, .m3u, .json). Add docs for Default Video Resolution and Default Subtitle Languages settings, and update the Output Filename Format variables to include %(playlist_index)s and %(resolution)s. These changes keep the README in sync with recent UI/settings additions.
2026-04-25 10:46:43 +03:00
oop7 ac5690b9b0 Add Concurrent Connections note to README
Document the new Concurrent Connections setting: explains that downloads can use multiple fragments concurrently to increase speed, where to find it (Download Settings → General → Concurrent Connections), the default value (1), and a recommended maximum (8–10) to avoid IP limiting.
2026-04-09 18:33:07 +02:00
oop7 62b8ede273 Add audio normalization docs and translations
Document Audio Normalization (EBU R128) in README and translated READMEs, and add corresponding localization keys and help text in ytsage language files. Updates include README.md, readme-translations (ar,de,es,fr,hi,id,it,ja,pl,pt,ru,tr,zh) and ytsage/languages JSON files to explain the feature and note that normalization requires re-encoding and forcing a specific audio format (e.g. MP3 or M4A).
2026-03-21 15:21:40 +02:00
oop7 9d1e83f7df Add README translations and language links
Add localized README files and update main README to expose them. Creates readme-translations/*.md (Arabic, German, Spanish, French, Hindi, Indonesian, Italian, Japanese, Polish, Portuguese, Russian, Turkish, Chinese) and adds a language list, README Translations table, and a "Contributing Translations" subsection to README.md so contributors can find and update localized docs.
2026-03-19 14:06:44 +02:00
oop7 fe828a5191 Reorganize README sections and update wording
Rename and restructure the options section: 'Advanced Options' becomes 'Media and Download Options', and new sections 'Output and File Settings', 'Access and Network', and 'Tools and Maintenance' are added. Clarify and reword items (subtitle embedding/merge, save thumbnail/description, trim video, speed limiter, proxy, cookie extraction), and consolidate updater/FFmpeg/yt-dlp/Deno detection and history/tooling notes. Documentation-only cleanup to improve clarity and discoverability of features.
2026-03-12 16:10:11 +02:00
oop7 c4c3e18b1b Document Generic Mode and add Sponsor section
Update README to document the new Optional Generic Mode: add a feature note, usage steps, troubleshooting notes (yt-dlp dependency, cookies/proxies), and a mention in Advanced Options and the features table. Also add a Sponsor anchor, nav link, and badge to the top navigation and About references. (Documentation-only changes)
2026-03-12 15:53:16 +02:00
oop7 7bf4eec9fa Remove extra blank line in README badges
Delete an unintended blank line between badge entries in README.md to tighten badge layout and clean up formatting. No functional changes.
2026-03-03 17:53:14 +02:00
oop7 86e0121a58 Adjust README badges' colors and order
Reorder and restyle README badges for consistent visual grouping. Several badges (downloads, license, supported platforms) were changed to a dark-gray color (1f2937) and grouped together, while GitHub Stars, PyPI version, and Sponsors badges were highlighted in red (c90000). This is a cosmetic update to improve badge contrast and layout.
2026-03-03 17:52:02 +02:00
oop7 1cfb106ccc Reorder badges in README.md
Move the PyPI version and License (MIT) badges down in the README header to improve grouping and visual flow of project badges (now placed after the GitHub Stars badge).
2026-03-03 17:48:42 +02:00
oop7 c34f33cc7a Add GitHub Sponsors badge to README
Adds a GitHub Sponsors badge (via shields.io) to the README, linking to https://github.com/sponsors/oop7 to promote project sponsorship. Minor documentation/branding enhancement.
2026-03-03 17:45:06 +02:00
oop7 3de27938d0 Add separator and update manual install heading
Insert a horizontal rule before the Manual Installation section and update the section summary emoji/text from '🛠️ Manual Installation from Source' to '💻 Manual Installation from Source' for improved readability and consistency in the README.
2026-03-03 16:18:28 +02:00
oop7 51d43e38bf Add download link and remove duplicate
Insert a 'Download Latest Release' callout under the Pre-built Executables section and remove a duplicate link later in the README so there's a single prominent release download link.
2026-03-03 16:16:25 +02:00
oop7 0d8bf820ec Add installation and update instructions to README
Add collapsible (details/summary) sections with step-by-step installation and upgrade instructions: pip upgrade for updating, Windows installer/portable/FFmpeg options, Linux packages (deb/rpm/AppImage/Flatpak) with example commands, and macOS DMG/zip steps plus a troubleshooting note. Improves clarity and discoverability of install/update procedures for users.
2026-03-03 16:14:37 +02:00
oop7 c8ecdf8eb6 Fix PyPI badge link and add platform badge
Update README badges: change the PyPI badge URL to the official PyPI project page (pypi.org) and add a 'Supported Platforms' badge indicating cross-platform support (linked to releases). This improves badge accuracy and highlights platform compatibility in the project README.
2026-02-07 16:03:39 +02:00
oop7 40069c039a Clarify README UI labels
Update README text to reflect UI label changes: 'Force Output Format' now points to 'Download Settings → Output Format Settings', and 'Download History' instructs users to click the 'History' button. Improves accuracy of guidance in the docs.
2026-02-07 15:48:11 +02:00
oop7 656a77f943 Document Output Filename Format option
Add a README entry describing the new Output Filename Format setting under Download Settings, showing example variables such as %(title)s, %(uploader)s, and %(resolution)s so users can customize downloaded filenames.
2026-02-07 15:29:42 +02:00
oop7 2e5e40cbf5 Update README for new directory structure and usage
Updated image paths and installation instructions to reflect the new project structure. The documentation now references the 'branding' directory instead of 'assets/branding', and installation uses 'pip install .' with module execution via 'python -m ytsage.main'. The project tree was revised to match the reorganized source and asset directories.
2026-01-25 14:05:05 +02:00
oop7 217c03379e Add ytsage_stylesheet.py to project structure in README
Updated the README to include the new ytsage_stylesheet.py file under the YTSage GUI directory, reflecting the addition of stylesheet definitions to the project.
2026-01-24 16:30:15 +02:00
oop7 3ae18678e8 Remove pyglet from dependencies list in README
The pyglet library has been removed from the dependencies table in the README, indicating it is no longer used for audio playback in the project.
2026-01-24 16:28:25 +02:00
oop7 9a81c4b564 Update badge labels in README
Changed the 'pypi downloads' and 'github downloads' badge labels to 'downloads' for consistency and improved readability.
2026-01-17 22:16:35 +02:00
oop7 ca7ac168fe Update badges in README with download stats
Replaces the generic downloads badge with separate PyPI and GitHub downloads badges for improved clarity. Enhances visibility of project statistics in the README.
2026-01-17 22:13:08 +02:00
oop7 2574ed0467 Add Flatpak badge to Linux install options
Included a Flathub badge in the Linux installation table to indicate Flatpak bundle availability.
2026-01-06 17:23:31 +02:00
oop7 462252b452 Fix formatting in workflows section of README
Corrected indentation and line formatting for the workflows section in the README to improve readability and consistency.
2026-01-06 16:04:59 +02:00
oop7 0edc64a5e9 Add release-all.yml to CI workflow list in README
Documented the master release workflow (release-all.yml) in the CI/CD section of the README for better visibility of available workflows.
2026-01-06 16:02:59 +02:00
oop7 4aa0a7b70e Update macOS ARM64 descriptions in README
Changed the descriptions for macOS ARM64 APP and DMG formats from 'for ARM64' to 'for Apple Silicon' for improved clarity in the README.
2025-12-11 13:29:31 +02:00
oop7 f03ab5093f Update README screenshots and asset list
Added references to new screenshots (Custom-Option.png, Download-Settings.png) and adjusted the order of listed files in the documentation assets section for clarity.
2025-11-17 17:24:49 +02:00
oop7 6ae92c937e Update screenshots and labels in README
Replaced images and updated corresponding labels in the screenshots table to reflect new interface sections and options.
2025-11-17 17:01:57 +02:00
oop7 a6f375abac Update README with new features and UI changes
Added details about audio format conversion and video format settings. Clarified UI options for saving download path and output format. Updated feature table to reflect new and improved functionalities.
2025-11-17 15:42:45 +02:00
oop7 8057b355ce Update README with new features and Deno support
Added details about Deno detection, updater tab, download history, and clarified output format options. Updated feature tables and instructions to reflect new capabilities and improved integration with Deno.
2025-11-14 20:02:24 +02:00
oop7 a3aebff19f Update README with deno detection and folder structure
Added deno to the detection features and clarified usage in the about dialog. Improved folder structure documentation for consistency, added missing files, and updated formatting for better readability. Also updated troubleshooting advice for format table display.
2025-11-14 19:13:28 +02:00
oop7 37f75b7d75 Update README with new module and dialog files
Added ytsage_ffmpeg_updater.py and ytsage_dialogs_updater.py to the project structure in the README to reflect recent additions to the codebase.
2025-11-12 18:13:35 +02:00
oop7 683946377e Update Python version badge in README
Changed the Python version badge from 3.9+ to 3.10+ to reflect updated minimum supported Python version.
2025-11-12 12:46:56 +02:00
oop7 f88cf66a23 Remove ytsage_style.py from package file list
The reference to ytsage_style.py was removed from the README to reflect its absence or deprecation in the codebase.
2025-11-04 22:03:13 +02:00
oop7 4d191427d9 Improve README advanced options section
Renamed the 'Options' section to 'Advanced Options' and clarified descriptions for several features, improving readability and consistency in the documentation.
2025-11-03 21:54:58 +02:00
oop7 d454b03b46 Update README options section and add history feature
Renamed 'Advanced Options' to 'Options' and added a description for the new history feature, allowing users to view past downloads and their statuses.
2025-11-03 21:54:08 +02:00
oop7 ac91fbd571 Update advanced options in README
Clarified and expanded descriptions for advanced options, including subtitle merging, custom commands, saving description/thumbnail, sponsor segment removal, speed limiter, download path, yt-dlp updates, FFmpeg/yt-dlp detection, and forced output format. Improves documentation accuracy and usability.
2025-11-03 21:49:58 +02:00
Mohamed 60a6eecc75 Update Extra Features section in README
Replace Save path with FPS/HDR Display
2025-11-01 11:28:48 +02:00
Your Name 0530f86a4c Update README with localization and utils changes
Added a new languages directory for localization files and updated the file tree to reflect new utility modules for configuration, localization, and logging. Removed the old logging utility reference and improved documentation structure.
2025-10-06 17:46:52 +03:00
Your Name 1a36cb1a81 Add localization section to README
Introduced a new section detailing support for 14 languages, including a table of supported languages and codes, and instructions for selecting a language. Encourages contributions for additional translations.
2025-10-06 17:43:17 +03:00
Your Name 5fc67ff48c Add proxy support feature to README
Documented the new proxy support feature, allowing users to specify a proxy server for downloads. This helps users understand how to use the proxy option with the application.
2025-10-06 16:33:10 +03:00
Your Name 0376c1c4cd Add proxy support to feature list in README
Updated the README to include proxy support as a listed feature, providing more accurate documentation of current capabilities.
2025-09-22 16:48:38 +03:00
Your Name 770acc2d16 Update README with SVG wordmark and badge formats
Replaced the YTSage title in README with an SVG wordmark and updated release format tables to use shield badges for Windows, Linux, and macOS. Added the ytsage-wordmark.svg asset and documented its location in the project structure.
2025-09-06 16:27:06 +03:00
Mohamed b063b4f01e Format project name and update Python version badge 2025-09-05 15:01:13 +03:00
Your Name b8af75848d Revise README with improved structure and details
Updated the README to use tables for executable formats, added new formats for Linux and macOS, expanded troubleshooting section, and revised the project folder structure for clarity. Also replaced the star history chart with a new source and improved its presentation.
2025-09-03 23:17:45 +03:00
Your Name edb06e8e03 Update README with executable details and cookie guide
Expanded the pre-built executables section to list all available Windows, Linux, and macOS package formats with descriptions. Improved instructions for logging in with cookies, highlighting the built-in extraction feature and clarifying manual steps. Removed outdated antivirus issue note for clarity.
2025-08-28 19:56:03 +03:00
Your Name bb7d000208 Update audio playback library reference in README
Changed the audio playback library reference from pygame to pyglet in the README to accurately reflect the project's dependencies.
2025-08-28 17:51:54 +03:00
Your Name d5b6b46b6c Update README.md 2025-08-27 15:40:50 +03:00
Your Name c91768aec4 Update README.md 2025-08-27 14:11:57 +03:00
Your Name 365fb7304b Update antivirus warning in README
Clarified that false positives may occur with packaged applications in general, not just those created with PyInstaller.
2025-08-27 01:32:03 +03:00
Your Name acb7c297a2 Update screenshot references and rename image files
Updated README.md to reference local screenshot files instead of external URLs. Renamed 'audio-only.png' to 'audio_format.png' and 'subtitles.png' to 'subtitle_options.png' for consistency with README references.
2025-08-27 01:19:24 +03:00