Skip to content

Commit b8e5146

Browse files
mapitmanCopilotCopilot
authored
Update README (#51)
* Update README - Add image of runtime - Add Mermaid diagram showing the flow of the application * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Fix Mermaid diagram filename format to match documented convention (#52) * Initial plan * Fix Mermaid diagram filename format to show Title (Year) Co-authored-by: mapitman <4205286+mapitman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: mapitman <4205286+mapitman@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: mapitman <4205286+mapitman@users.noreply.github.com>
1 parent 13071f3 commit b8e5146

2 files changed

Lines changed: 41 additions & 2 deletions

File tree

README.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Automatic DVD, Blu-Ray, and UltraHD Blu-Ray ripping tool with intelligent metadata lookup and file organization.
44

5+
![RipSharp Demo](demo.png)
6+
57
## Quick Start
68

79
### 1) Install MakeMKV, FFmpeg, and .NET SDK 10+
@@ -64,6 +66,27 @@ This will:
6466
4. Rip each episode with English audio/subtitles
6567
5. Save as `~/TV/Breaking Bad - S01E01 - Pilot.mkv`, etc.
6668

69+
## Features
70+
71+
### Real-Time Progress Display
72+
73+
RipSharp provides a real-time three-bar progress display showing:
74+
- **Ripping Progress** - Current disc title being ripped (0-100% per title, not cumulative)
75+
- **Encoding Progress** - Current video being encoded with real-time speed and ETA
76+
- **Overall Progress** - Total completion across all titles
77+
78+
Each bar displays elapsed and remaining time in MM:SS or H:MM:SS format for accurate time estimation.
79+
80+
### Automatic Cleanup
81+
82+
Temporary directories created by RipSharp are automatically removed after successful ripping and encoding. Only manually specified temp directories are preserved.
83+
84+
### Parallel Processing
85+
86+
RipSharp rips and encodes titles in parallel for improved performance:
87+
- While one title is being ripped, the previous title's MKV can be encoded simultaneously
88+
- Graceful handling of Ctrl+C with proper cursor restoration and cleanup
89+
6790
## Command-Line Options
6891

6992
| Option | Value | Default | Description |
@@ -178,9 +201,25 @@ The application:
178201
1. **Scans disc** - Uses `makemkvcon` to identify all titles and their properties
179202
2. **Identifies content** - Finds the main feature (movies) or episodes (TV series)
180203
3. **Looks up metadata** - Queries OMDB then TMDB for official titles and years; queries TVDB for TV episode titles
181-
4. **Rips titles** - Extracts using MakeMKV at highest available quality
204+
4. **Rips & encodes** - Extracts using MakeMKV at highest available quality; ripping and encoding happen in parallel for efficiency
182205
5. **Selects tracks** - Includes English audio and subtitles only
183-
6. **Renames & saves** - Moves to output directory with proper naming
206+
6. **Renames & saves** - Moves to output directory with proper naming; auto-cleans temporary directory after successful completion
207+
208+
```mermaid
209+
graph TD
210+
A["Insert Disc"] --> B["Scan Disc<br/>makemkvcon info"]
211+
B --> C{"Detect<br/>Content Type"}
212+
C -->|Movie| D["Identify Main Feature<br/>45+ minutes"]
213+
C -->|TV Series| E["Identify Episodes<br/>20-50 minutes each"]
214+
D --> F["Query Metadata<br/>OMDB/TMDB"]
215+
E --> G["Query Metadata<br/>OMDB/TMDB + TVDB"]
216+
F --> H["Rip with MakeMKV<br/>Highest Quality"]
217+
G --> H
218+
H --> I["Select Tracks<br/>English Audio/Subtitles"]
219+
I --> J["Generate Filename<br/>Title (Year) or<br/>Show - S##E## - Title"]
220+
J --> K["Save to Output<br/>Directory"]
221+
K --> L["Complete ✓"]
222+
```
184223

185224
### File Naming
186225

demo.png

503 KB
Loading

0 commit comments

Comments
 (0)