Skip to content

Commit 3c7e2b0

Browse files
m_igashim_igashi
authored andcommitted
roadmap update
1 parent 8dde5b1 commit 3c7e2b0

File tree

2 files changed

+86
-43
lines changed

2 files changed

+86
-43
lines changed

README.md

Lines changed: 43 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,53 @@ mp3rgain adjusts MP3 volume without re-encoding by modifying the `global_gain` f
2222

2323
## Installation
2424

25-
### Homebrew (macOS)
25+
### Windows
2626

27+
**Download and extract** (recommended for most users):
28+
29+
1. Download the latest release from [GitHub Releases](https://github.com/M-Igashi/mp3rgain/releases):
30+
- `mp3rgain-*-windows-x86_64.zip` (most Windows PCs)
31+
- `mp3rgain-*-windows-arm64.zip` (ARM-based Windows devices)
32+
33+
2. Extract the ZIP file to a folder (e.g., `C:\Tools\mp3rgain`)
34+
35+
3. Open PowerShell or Command Prompt and navigate to the folder:
36+
```powershell
37+
cd C:\Tools\mp3rgain
38+
.\mp3rgain.exe -h
39+
```
40+
41+
4. (Optional) Add to PATH for system-wide access:
42+
- Open "Edit environment variables for your account" from Start menu
43+
- Edit the `Path` variable and add your folder (e.g., `C:\Tools\mp3rgain`)
44+
- Restart your terminal
45+
46+
> **Note:** mp3rgain is a command-line tool, not a GUI application. Double-clicking the executable will briefly open and close a terminal window. Always run it from PowerShell or Command Prompt.
47+
48+
**Using Cargo** (for Rust developers):
49+
```powershell
50+
cargo install mp3rgain
51+
```
52+
53+
### macOS
54+
55+
**Homebrew** (recommended):
2756
```bash
2857
brew install M-Igashi/tap/mp3rgain
2958
```
3059

60+
**Download binary:**
61+
1. Download `mp3rgain-*-macos-universal.tar.gz` from [GitHub Releases](https://github.com/M-Igashi/mp3rgain/releases)
62+
2. Extract: `tar -xzf mp3rgain-*-macos-universal.tar.gz`
63+
3. Move to PATH: `sudo mv mp3rgain /usr/local/bin/`
64+
65+
### Linux
66+
67+
**Download binary:**
68+
1. Download `mp3rgain-*-linux-x86_64.tar.gz` from [GitHub Releases](https://github.com/M-Igashi/mp3rgain/releases)
69+
2. Extract: `tar -xzf mp3rgain-*-linux-x86_64.tar.gz`
70+
3. Move to PATH: `sudo mv mp3rgain /usr/local/bin/`
71+
3172
### Cargo (all platforms)
3273

3374
```bash
@@ -38,15 +79,7 @@ cargo install mp3rgain
3879
cargo install mp3rgain --no-default-features
3980
```
4081

41-
### Download binary
42-
43-
Download the latest release from [GitHub Releases](https://github.com/M-Igashi/mp3rgain/releases):
44-
- macOS (Universal): `mp3rgain-*-macos-universal.tar.gz`
45-
- Linux (x86_64): `mp3rgain-*-linux-x86_64.tar.gz`
46-
- Windows (x86_64): `mp3rgain-*-windows-x86_64.zip`
47-
- Windows (ARM64): `mp3rgain-*-windows-arm64.zip`
48-
49-
All binaries include full ReplayGain support.
82+
All binaries include full ReplayGain support with zero runtime dependencies.
5083

5184
## Quick Start
5285

docs/roadmap.md

Lines changed: 43 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,76 @@
11
# mp3rgain Roadmap
22

3-
## Current Status: v0.1.0
3+
## Current Status: v1.0.0 (Production Ready)
44

5-
Core functionality complete:
5+
All core functionality complete:
66
- [x] MP3 frame parsing (MPEG 1/2/2.5 Layer III)
77
- [x] Global gain modification
88
- [x] ID3v2 tag preservation
99
- [x] VBR/CBR support
1010
- [x] CLI interface (apply/info/undo commands)
11+
- [x] ReplayGain analysis (track and album gain)
12+
- [x] AAC/M4A support (ReplayGain tags)
13+
- [x] Full mp3gain command-line compatibility
14+
- [x] Cross-platform support (Windows, macOS, Linux)
1115

12-
## Short-term Goals
16+
## Completed Milestones
1317

1418
### v0.2.0 - Windows & Stability
1519

16-
- [ ] Windows 11 compatibility verification
17-
- [ ] Windows ARM64 support
18-
- [ ] Comprehensive test suite with real MP3 files
19-
- [ ] Error handling improvements
20-
- [ ] Homebrew official formula submission
20+
- [x] Windows 11 compatibility verification
21+
- [x] Windows ARM64 support
22+
- [x] Comprehensive test suite with real MP3 files
23+
- [x] Error handling improvements
24+
- [x] Homebrew tap formula
2125

2226
### v0.3.0 - mp3gain Feature Parity
2327

24-
- [ ] ReplayGain analysis (track gain calculation)
25-
- [ ] Album gain support
26-
- [ ] `-r` (apply Track gain) flag compatibility
27-
- [ ] `-a` (apply Album gain) flag compatibility
28-
- [ ] `-c` (ignore clipping) flag
29-
- [ ] `-p` (preserve original timestamp) flag
30-
31-
## Medium-term Goals
28+
- [x] ReplayGain analysis (track gain calculation)
29+
- [x] Album gain support
30+
- [x] `-r` (apply Track gain) flag compatibility
31+
- [x] `-a` (apply Album gain) flag compatibility
32+
- [x] `-c` (ignore clipping) flag
33+
- [x] `-p` (preserve original timestamp) flag
3234

3335
### v0.4.0 - Extended Features
3436

35-
- [ ] Batch processing improvements
36-
- [ ] Progress bar for large files
37-
- [ ] JSON output format
38-
- [ ] Dry-run mode
39-
- [ ] Undo log file (for exact restoration)
37+
- [x] Batch processing with recursive directory support
38+
- [x] Progress bar for large files
39+
- [x] JSON output format
40+
- [x] Dry-run mode
41+
- [x] TSV output format
4042

41-
### v0.5.0 - Additional Formats (Optional)
43+
### v1.0.0 - AAC/M4A Support
4244

43-
- [ ] AAC/M4A support (like aacgain)
44-
- [ ] FLAC support (optional)
45-
- [ ] Ogg Vorbis support (optional)
45+
- [x] AAC/M4A ReplayGain analysis
46+
- [x] iTunes freeform tag writing
47+
- [x] Multi-track audio support (`-i` option)
48+
- [x] Production-ready release
49+
50+
## Upcoming Goals
51+
52+
### v1.2.0 - Package Manager Expansion
4653

47-
## Long-term Goals
54+
- [ ] Scoop package (Windows) - *in progress*
55+
- [ ] winget package (Windows Package Manager)
56+
- [ ] Homebrew core inclusion
57+
- [ ] AUR package (Arch Linux)
58+
- [ ] Nix package
59+
60+
### Future
4861

4962
- [ ] GUI wrapper (optional)
63+
- [ ] FLAC support (optional)
64+
- [ ] Ogg Vorbis support (optional)
5065
- [ ] Library API stabilization
5166
- [ ] Integration with music players/taggers
52-
- [ ] Homebrew core inclusion
5367

5468
## Community Goals
5569

5670
- [ ] Reach 100 GitHub stars
5771
- [ ] 5+ contributors
58-
- [ ] Windows user base
59-
- [ ] Package manager availability (beyond Homebrew)
60-
- [ ] Scoop (Windows)
61-
- [ ] winget (Windows)
62-
- [ ] AUR (Arch Linux)
63-
- [ ] Nix
72+
- [ ] Grow Windows user base
73+
- [ ] Package availability in major package managers
6474

6575
---
6676

0 commit comments

Comments
 (0)