Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: refine readme with ci status and star history #30

Merged
merged 2 commits into from
Jan 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "ainojimakugumi"
description = "aI NO jimaKu gumI, a sub-title maker using AI."
description = "aI NO jimaKu gumI, a subtitle maker using AI."
version = "0.1.0"
edition = "2021"

Expand Down
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# AI no jimaku gumi (AIの字幕組)

AI no jimaku gumi is a cli utility to facilitate the translation of video.
[![Build and test on Linux](https://github.com/Inokinoki/ai-no-jimaku-gumi/actions/workflows/linux-rust.yml/badge.svg)](https://github.com/Inokinoki/ai-no-jimaku-gumi/actions/workflows/linux-rust.yml)

AI no jimaku gumi is a cli utility to facilitate the translation and subtitle making of video.

## Setup

Expand Down Expand Up @@ -28,21 +30,21 @@ brew install cmake ffmpeg

Ubuntu:

```
```bash
apt-get install -y clang cmake make pkg-config \
libavcodec-dev libavdevice-dev libavfilter-dev libavformat-dev \
libavutil-dev libpostproc-dev libswresample-dev libswscale-dev
```

Fedora:

```
```bash
dnf install clang cmake ffmpeg-free-devel make pkgconf-pkg-config
```

Arch Linux:

```
```bash
pacman -S clang cmake ffmpeg make pkgconf
```

Expand Down Expand Up @@ -74,21 +76,21 @@ Run it with your video path after `--input-video-path` and target language after
To use AI no jimaku gumi, refer this help:

```
aI NO jimaKu gumI, a sub-title maker using AI.
aI NO jimaKu gumI, a subtitle maker using AI.

Usage: ainojimakugumi [OPTIONS] --input-video-path <INPUT_VIDEO_PATH>

Options:
-i, --input-video-path <INPUT_VIDEO_PATH>
Name of the person to greet
Path to the input video
--source-language <SOURCE_LANGUAGE>
Which language to translate from (default: "ja") (possible values: "en", "es", "fr", "de", "it", "ja", "ko", "pt", "ru", "zh") (example: "ja") [default: ja]
--target-language <TARGET_LANGUAGE>
Which language to translate to (default: "en") (possible values: "en", "es", "fr", "de", "it", "ja", "ko", "pt", "ru", "zh") (example: "en") [default: en]
--start-time <START_TIME>
Video start time [default: 0]
Video start time (not used yet) [default: 0]
--end-time <END_TIME>
Video end time [default: 0]
Video end time (not used yet) [default: 0]
--subtitle-source <SUBTITLE_SOURCE>
Subtitle source (default: "audio") (possible values: "audio", "container", "ocr") (example: "audio") (long_about: "Subtitle source to use") [default: audio]
--ggml-model-path <GGML_MODEL_PATH>
Expand Down Expand Up @@ -136,3 +138,13 @@ export CUSTOM_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxx
--llm-model-name 'gpt-4o-mini'
--ggml-model-path ggml-small.bin
```

## Star History

<a href="https://star-history.com/#Inokinoki/ai-no-jimaku-gumi&Date">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Inokinoki/ai-no-jimaku-gumi&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Inokinoki/ai-no-jimaku-gumi&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Inokinoki/ai-no-jimaku-gumi&type=Date" />
</picture>
</a>
6 changes: 3 additions & 3 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ use tempfile::TempDir;
#[derive(Parser, Debug)]
#[command(version, about, long_about = None)]
struct Args {
/// Name of the person to greet
/// Path to the input video
#[arg(short, long)]
input_video_path: String,

Expand All @@ -34,11 +34,11 @@ struct Args {
#[arg(long, default_value = "en")]
target_language: String,

/// Video start time
/// Video start time (not used yet)
#[arg(long, default_value = "0")]
start_time: usize,

/// Video end time
/// Video end time (not used yet)
#[arg(long, default_value = "0")]
end_time: usize,

Expand Down
Loading