Skip to content

Commit

Permalink
Name change
Browse files Browse the repository at this point in the history
  • Loading branch information
rasmus-kirk committed Sep 20, 2024
1 parent 01e8d59 commit 2e99640
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[package]
name = "sub-merge"
name = "submerger"
version = "0.1.2"
edition = "2021"
description = "Submerge combines subtitles from two files into one, with customizable position and color settings"
description = "Submerger combines subtitles from two files into one, with customizable position and color settings"
license = "MIT"
repository = "https://github.com/rasmus-kirk/sub-merge"
repository = "https://github.com/rasmus-kirk/submerger.git"

[dependencies]
clap = { version = "4.0", features = ["derive"] }
Expand Down
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Submerge
# Submerger

**Submerge** is a simple tool designed to merge subtitles from two different
**Submerger** is a simple tool designed to merge subtitles from two different
files into a single output file. It's especially useful for language learners
who want to watch content with subtitles in multiple languages simultaneously.

Expand All @@ -27,7 +27,7 @@ preferences.
To install using cargo:

```bash
cargo install sub-merge
cargo install submerger
```

#### Building
Expand All @@ -37,8 +37,8 @@ One way to build this project is using [Rust](https://www.rust-lang.org/tools/in
Clone the repository:

```bash
git clone https://github.com/rasmus-kirk/sub-merge.git
cd subtitle-merger
git clone https://github.com/rasmus-kirk/submerger.git
cd submerger
```

Build the project:
Expand All @@ -52,23 +52,23 @@ cargo build --release
#### Installation

```bash
nix profile install github:rasmus-kirk/sub-merge
nix profile install github:rasmus-kirk/submerger
```

#### Building

This project has a nix flake, so it can be built using nix:

```bash
nix build github:rasmus-kirk/sub-merge
nix build github:rasmus-kirk/submerger
```

#### Running

If you just wish to run the program using nix:

```bash
nix run github:rasmus-kirk/sub-merge -- --help
nix run github:rasmus-kirk/submerger -- --help
```

#### Developement Shell
Expand All @@ -77,13 +77,13 @@ To enter a developement shell with the correct rust-toolchain and rust
analyzer using nix:

```bash
nix develop github:rasmus-kirk/sub-merge
nix develop github:rasmus-kirk/submerger
```

If you use a shell other than bash:

```bash
nix develop github:rasmus-kirk/sub-merge -c $SHELL
nix develop github:rasmus-kirk/submerger -c $SHELL
```

## Usage
Expand All @@ -96,7 +96,7 @@ for matching subtitle pairs.
Merge two subtitle files into a single output:

```
sub-merge simple [OPTIONS] <SUB1> <SUB2> <OUT>
submerger simple [OPTIONS] <SUB1> <SUB2> <OUT>
```

Required:
Expand All @@ -115,15 +115,15 @@ Optional:
#### Example

```bash
sub-merge simple movie.en.srt movie.ja.srt --out merged.srt --color "#fbf1c7" --position top-center
submerger simple movie.en.srt movie.ja.srt --out merged.srt --color "#fbf1c7" --position top-center
```

### 2. Recursive Subtitle Merging

Search a directory for subtitle files matching given language codes and merge them:

```
sub-merge recursive [OPTIONS] <SUB1_LANG> <SUB2_LANG> <PATH>
submerger recursive [OPTIONS] <SUB1_LANG> <SUB2_LANG> <PATH>
```

Required:
Expand Down Expand Up @@ -155,7 +155,7 @@ Optional:
#### Example

```bash
sub-merge recursive en ja ./movies --color "#fbf1c7" --position top-center
submerger recursive en ja ./movies --color "#fbf1c7" --position top-center
```

## License
Expand Down
2 changes: 1 addition & 1 deletion flake.nix
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
description = "Submerge combines subtitles from two files into one, with customizable position and color settings";
description = "Submerger combines subtitles from two files into one, with customizable position and color settings";

inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
Expand Down

0 comments on commit 2e99640

Please sign in to comment.