Revise instructions in README

Updated CLI and GUI publishing instructions for self-contained builds on various platforms
Updated the CLI and GUI usage guide
This commit is contained in:
2026-06-26 00:28:03 +07:00
committed by GitHub
parent 1c5d2e3934
commit 02176d0d7e
+32 -17
View File
@@ -28,19 +28,27 @@ The application runs in two modes — **GUI** (no arguments) and **CLI** (with a
4. Adjust settings as needed 4. Adjust settings as needed
5. Click **Convert** 5. Click **Convert**
> **Note:** The GUI is experimental. Feedback and bug reports are welcome!
### Command Line ### Command Line
Pass any argument to trigger CLI mode: The CLI runs on **Windows, Linux, and macOS**.
#### Drag and drop:
1. Drag and drop an `.srt` file onto `ConvertSRTto3DASS`
- Uses default settings (SBS mode, 1280x720)
2. The resulting `.ass` file will be saved in the same directory as the `.srt`
#### Command line:
``` ```
ConvertSRTto3DASS.exe input.srt [options] ConvertSRTto3DASS.exe input.srt [options]
```
Or drag and drop an `.srt` file onto the executable.
Available options:
``` ```
##### Available options:
```
--mode sbs|ou|rg 3D mode (default: sbs) --mode sbs|ou|rg 3D mode (default: sbs)
--resx <number> Output width --resx <number> Output width
--resy <number> Output height --resy <number> Output height
@@ -54,17 +62,17 @@ Available options:
--verticalmargin <number> General vertical margin --verticalmargin <number> General vertical margin
--output <path> Output file path --output <path> Output file path
--help, -h, /? Show help --help, -h, /? Show help
```
Examples:
``` ```
##### Examples:
```
ConvertSRTto3DASS.exe movie.srt --mode sbs ConvertSRTto3DASS.exe movie.srt --mode sbs
ConvertSRTto3DASS.exe movie.srt --mode ou --resx 1920 --resy 1080 ConvertSRTto3DASS.exe movie.srt --mode ou --resx 1920 --resy 1080
ConvertSRTto3DASS.exe movie.srt --mode rg --offsetx 6 --bottomoffset 24 ConvertSRTto3DASS.exe movie.srt --mode rg --offsetx 6 --bottomoffset 24
```
> **Note:** The GUI is experimental. Feedback and bug reports are welcome! ```
## Known Issues ## Known Issues
@@ -83,15 +91,22 @@ ConvertSRTto3DASS.exe movie.srt --mode rg --offsetx 6 --bottomoffset 24
# Build all projects # Build all projects
dotnet build dotnet build
# Publish CLI (cross-platform) # Publish CLI (self-contained)
dotnet publish ConvertSRTto3DASS.Cli -c Release -r linux-x64 --self-contained false -p:PublishSingleFile=true ## Linux x64
dotnet publish ConvertSRTto3DASS.Cli -c Release -r osx-x64 --self-contained false -p:PublishSingleFile=true dotnet publish ConvertSRTto3DASS.Cli -c Release -r linux-x64 --self-contained true -p:PublishSingleFile=true -p:IncludeNativeLibrariesForSelfExtract=true
dotnet publish ConvertSRTto3DASS.Cli -c Release -r win-x64 --self-contained false -p:PublishSingleFile=true ## OSX x64
dotnet publish ConvertSRTto3DASS.Cli -c Release -r osx-x64 --self-contained true -p:PublishSingleFile=true -p:IncludeNativeLibrariesForSelfExtract=true
## OSX arm64
dotnet publish ConvertSRTto3DASS.Cli -c Release -r osx-arm64 --self-contained false -p:PublishSingleFile=true -p:IncludeNativeLibrariesForSelfExtract=true
## Windows x64
dotnet publish ConvertSRTto3DASS.Cli -c Release -r win-x64 --self-contained true -p:PublishSingleFile=true -p:IncludeNativeLibrariesForSelfExtract=true
# Publish GUI (Windows only) # Publish GUI (Windows x64 only, self-contained)
dotnet publish ConvertSRTto3DASS.Gui -c Release -r win-x64 --self-contained false -p:PublishSingleFile=true dotnet publish ConvertSRTto3DASS.Gui -c Release -r win-x64 --self-contained true -p:PublishSingleFile=true -p:IncludeNativeLibrariesForSelfExtract=true
``` ```
_Each publish produces a single .exe with no .dll sidecars._
## License ## License
MIT License — Copyright © imrayya 2021-2026 MIT License — Copyright © imrayya 2021-2026