From 2e996409fcb442c2a66bbdd06cc1c1affe521f14 Mon Sep 17 00:00:00 2001 From: rasmus-kirk Date: Fri, 20 Sep 2024 16:22:55 +0200 Subject: [PATCH] Name change --- Cargo.lock | 2 +- Cargo.toml | 6 +++--- README.md | 28 ++++++++++++++-------------- flake.nix | 2 +- 4 files changed, 19 insertions(+), 19 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 997f391..a7d97e6 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -316,7 +316,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f" [[package]] -name = "sub-merge" +name = "submerger" version = "0.1.2" dependencies = [ "anyhow", diff --git a/Cargo.toml b/Cargo.toml index b4028e6..cb47738 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -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"] } diff --git a/README.md b/README.md index 26997a4..3c3d55a 100644 --- a/README.md +++ b/README.md @@ -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. @@ -27,7 +27,7 @@ preferences. To install using cargo: ```bash -cargo install sub-merge +cargo install submerger ``` #### Building @@ -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: @@ -52,7 +52,7 @@ cargo build --release #### Installation ```bash -nix profile install github:rasmus-kirk/sub-merge +nix profile install github:rasmus-kirk/submerger ``` #### Building @@ -60,7 +60,7 @@ nix profile install github:rasmus-kirk/sub-merge 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 @@ -68,7 +68,7 @@ nix build github:rasmus-kirk/sub-merge 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 @@ -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 @@ -96,7 +96,7 @@ for matching subtitle pairs. Merge two subtitle files into a single output: ``` -sub-merge simple [OPTIONS] +submerger simple [OPTIONS] ``` Required: @@ -115,7 +115,7 @@ 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 @@ -123,7 +123,7 @@ sub-merge simple movie.en.srt movie.ja.srt --out merged.srt --color "#fbf1c7" -- Search a directory for subtitle files matching given language codes and merge them: ``` -sub-merge recursive [OPTIONS] +submerger recursive [OPTIONS] ``` Required: @@ -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 diff --git a/flake.nix b/flake.nix index 1b316ac..7eadb90 100644 --- a/flake.nix +++ b/flake.nix @@ -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";