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.
This commit is contained in:
@@ -1,7 +1,7 @@
|
|||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
<img src="assets\branding\svg\ytsage-wordmark.svg" width="400" alt="ytsage-wordmark">
|
<img src="branding\svg\ytsage-wordmark.svg" width="400" alt="ytsage-wordmark">
|
||||||
<img src="assets\branding\screenshots\main.png" width="800" alt="YTSage Interface"/>
|
<img src="branding\screenshots\main.png" width="800" alt="YTSage Interface"/>
|
||||||
|
|
||||||
[](https://badge.fury.io/py/ytsage)
|
[](https://badge.fury.io/py/ytsage)
|
||||||
[](https://opensource.org/licenses/MIT)
|
[](https://opensource.org/licenses/MIT)
|
||||||
@@ -114,19 +114,19 @@ cd YTSage
|
|||||||
#### ⚡ With uv
|
#### ⚡ With uv
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
uv pip install -r requirements.txt
|
uv pip install .
|
||||||
```
|
```
|
||||||
|
|
||||||
#### 📦 Or with standard pip
|
#### 📦 Or with standard pip
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install -r requirements.txt
|
pip install .
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3. Run the Application
|
### 3. Run the Application
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python main.py
|
python -m ytsage.main
|
||||||
```
|
```
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
@@ -137,16 +137,16 @@ python main.py
|
|||||||
<div align="center">
|
<div align="center">
|
||||||
<table>
|
<table>
|
||||||
<tr>
|
<tr>
|
||||||
<td><img src="assets\branding\screenshots\Download-Settings.png" alt="Download Settings" width="400"/></td>
|
<td><img src="branding\screenshots\Download-Settings.png" alt="Download Settings" width="400"/></td>
|
||||||
<td><img src="assets\branding\screenshots\playlist.png" alt="Playlist Download" width="400"/></td>
|
<td><img src="branding\screenshots\playlist.png" alt="Playlist Download" width="400"/></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td align="center"><em>Download Settings</em></td>
|
<td align="center"><em>Download Settings</em></td>
|
||||||
<td align="center"><em>Playlist Download</em></td>
|
<td align="center"><em>Playlist Download</em></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td><img src="assets\branding\screenshots\audio_format.png" alt="Audio Format Selection with Save Thumbnail" width="400"/></td>
|
<td><img src="branding\screenshots\audio_format.png" alt="Audio Format Selection with Save Thumbnail" width="400"/></td>
|
||||||
<td><img src="assets\branding\screenshots\Custom-Option.png" alt="Custom Options" width="400"/></td>
|
<td><img src="branding\screenshots\Custom-Option.png" alt="Custom Options" width="400"/></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td align="center"><em>Audio Format</em></td>
|
<td align="center"><em>Audio Format</em></td>
|
||||||
@@ -344,47 +344,23 @@ YTSage/
|
|||||||
│ │ │── build-windows.yml # Windows build workflow
|
│ │ │── build-windows.yml # Windows build workflow
|
||||||
| | └── release-all.yml # Master release workflow
|
| | └── release-all.yml # Master release workflow
|
||||||
│ └── 📄 CI_CD_README.md # CI/CD documentation
|
│ └── 📄 CI_CD_README.md # CI/CD documentation
|
||||||
├── 📁 assets/ # Static assets and resources
|
├── 📁 branding/ # Branding assets (Screenshots, SVGs)
|
||||||
│ ├── 📁 branding/ # Branding assets
|
│ ├── 📁 icons/ # Application icons
|
||||||
│ │ ├── 📁 icons/ # Application icons
|
│ ├── 📁 screenshots/ # Screenshots for documentation
|
||||||
│ │ │ ├── icon.icns # macOS icon
|
│ └── 📁 svg/ # SVG assets
|
||||||
│ │ │ ├── icon.png # PNG icon
|
├── 📄 LICENSE # License file
|
||||||
│ │ │ └── YTSage.ico # Windows icon
|
├── 📄 pyproject.toml # Project metadata and dependencies
|
||||||
│ │ ├── 📁 screenshots/ # Screenshots for documentation
|
├── 📄 README.md # Project documentation
|
||||||
│ │ │ ├── audio_format.png
|
├── 📄 requirements.txt # Python dependencies (dev)
|
||||||
│ │ │ ├── Custom-Option.png
|
└── 📁 ytsage/ # Source package
|
||||||
│ │ │ ├── Download-Settings.png
|
├── 📁 assets/ # Runtime assets
|
||||||
│ │ │ ├── playlist.png
|
│ ├── 📁 Icon/ # Application icons
|
||||||
│ │ │ └── main.png
|
|
||||||
│ │ └── 📁 svg/ # SVG assets
|
|
||||||
│ │ └── ytsage-wordmark.svg
|
|
||||||
│ │ └── ytsage-wordmark.svg
|
|
||||||
│ ├── 📁 Icon/ # Legacy icon directory
|
|
||||||
│ │ └── icon.png
|
|
||||||
│ └── 📁 sound/ # Audio files
|
│ └── 📁 sound/ # Audio files
|
||||||
│ └── notification.mp3
|
|
||||||
├── 📁 languages/ # Localization files
|
├── 📁 languages/ # Localization files
|
||||||
│ ├── 📄 ar.json # Arabic translation
|
│ ├── 📄 ar.json # Arabic translation
|
||||||
│ ├── 📄 de.json # German translation
|
│ ├── 📄 de.json # German translation
|
||||||
│ ├── 📄 en.json # English translation
|
│ ├── 📄 en.json # English translation
|
||||||
│ ├── 📄 es.json # Spanish translation
|
│ └── ... # Other languages
|
||||||
│ ├── 📄 fr.json # French translation
|
|
||||||
│ ├── 📄 hi.json # Hindi translation
|
|
||||||
│ ├── 📄 id.json # Indonesian translation
|
|
||||||
│ ├── 📄 it.json # Italian translation
|
|
||||||
│ ├── 📄 ja.json # Japanese translation
|
|
||||||
│ ├── 📄 pl.json # Polish translation
|
|
||||||
│ ├── 📄 pt.json # Portuguese translation
|
|
||||||
│ ├── 📄 ru.json # Russian translation
|
|
||||||
│ ├── 📄 tr.json # Turkish translation
|
|
||||||
│ └── 📄 zh.json # Chinese translation
|
|
||||||
├── 📄 LICENSE # License file
|
|
||||||
├── 📄 main.py # Application entry point
|
|
||||||
├── 📄 README.md # Project documentation
|
|
||||||
├── 📄 .gitignore # Git ignore rules
|
|
||||||
├── 📄 requirements.txt # Python dependencies
|
|
||||||
└── 📁 src/ # Source code
|
|
||||||
|
|
|
||||||
├── 📁 core/ # Core business logic
|
├── 📁 core/ # Core business logic
|
||||||
│ ├── 📄 __init__.py # Core package init
|
│ ├── 📄 __init__.py # Core package init
|
||||||
│ ├── 📄 ytsage_deno.py # Deno integration
|
│ ├── 📄 ytsage_deno.py # Deno integration
|
||||||
@@ -394,27 +370,14 @@ YTSage/
|
|||||||
│ └── 📄 ytsage_yt_dlp.py # yt-dlp integration
|
│ └── 📄 ytsage_yt_dlp.py # yt-dlp integration
|
||||||
├── 📁 gui/ # User interface components
|
├── 📁 gui/ # User interface components
|
||||||
│ ├── 📄 __init__.py # GUI package init
|
│ ├── 📄 __init__.py # GUI package init
|
||||||
│ ├── 📄 ytsage_gui_format_table.py # Format table functionality
|
|
||||||
│ ├── 📄 ytsage_gui_main.py # Main application window
|
│ ├── 📄 ytsage_gui_main.py # Main application window
|
||||||
│ ├── 📄 ytsage_gui_video_info.py # Video information display
|
|
||||||
| ├── 📄 ytsage_stylesheet.py # Stylesheet definitions
|
|
||||||
│ └── 📁 ytsage_gui_dialogs/ # Dialog classes
|
│ └── 📁 ytsage_gui_dialogs/ # Dialog classes
|
||||||
│ ├── 📄 __init__.py # Dialogs package init
|
├── 📁 utils/ # Utility modules
|
||||||
│ ├── 📄 ytsage_dialogs_base.py # Basic dialogs
|
│ ├── 📄 __init__.py # Utils package init
|
||||||
│ ├── 📄 ytsage_dialogs_custom.py # Custom functionality dialogs
|
│ ├── 📄 ytsage_config_manager.py # Configuration management
|
||||||
│ ├── 📄 ytsage_dialogs_ffmpeg.py # FFmpeg-related dialogs
|
│ └── 📄 ytsage_logger.py # Logging utilities
|
||||||
│ ├── 📄 ytsage_dialogs_history.py # History dialogs
|
├── 📄 __init__.py # Package entry point
|
||||||
│ ├── 📄 ytsage_dialogs_selection.py # Selection dialogs
|
└── 📄 main.py # Main execution script
|
||||||
│ ├── 📄 ytsage_dialogs_settings.py # Settings dialogs
|
|
||||||
│ ├── 📄 ytsage_dialogs_update.py # Update dialogs
|
|
||||||
│ └── 📄 ytsage_dialogs_updater.py # Updater dialogs
|
|
||||||
└── 📁 utils/ # Utility modules
|
|
||||||
├── 📄 __init__.py # Utils package init
|
|
||||||
├── 📄 ytsage_config_manager.py # Configuration management
|
|
||||||
├── 📄 ytsage_constants.py # Application constants
|
|
||||||
├── 📄 ytsage_history_manager.py # History management
|
|
||||||
├── 📄 ytsage_localization.py # Localization utilities
|
|
||||||
└── 📄 ytsage_logger.py # Logging utilities
|
|
||||||
```
|
```
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|||||||
Reference in New Issue
Block a user