Skip to content

Commit

Permalink
docs: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dreamjz committed Nov 23, 2023
1 parent 09afadd commit 8aa12de
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 2 deletions.
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,36 @@
# sub-renamer
# Sub-Renamer

English | [简体中文](./README_ZH_CN.md)

CLI tool to auto-rename subtitle files for matched video files.

## Installation

### Using `go`

```sh
$ go install https://github.com/acgtools/sub-renamer@latest
```

### Download from releases

[Release page](https://github.com/acgtools/sub-renamer/releases)

## Quick Start

```sh
$ sub-reanmer -h
sub-renamer <video dir> <sub dir>

Usage:
sub-renamer [flags]

Flags:
-h, --help help for sub-renamer
--log-level string log level, options: debug, info, warn, error (default "info")
```

## Issue

Feel free to create issues for reporting bugs or requesting new features.

36 changes: 36 additions & 0 deletions README_ZH_CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Sub-Renamer

English | [简体中文](./)

自动为字幕文件匹配视频并重命名的 CLI 工具。

## 安装

### 使用 `go`

```sh
$ go install https://github.com/acgtools/sub-renamer@latest
```

### 从 Release 页面下载

[Release page](https://github.com/acgtools/sub-renamer/releases)

## 快速开始

```sh
$ sub-reanmer -h
sub-renamer <video dir> <sub dir>

Usage:
sub-renamer [flags]

Flags:
-h, --help help for sub-renamer
--log-level string log level, options: debug, info, warn, error (default "info")
```

## Issue

欢迎创建 issue 来报告 bug 或者 请求添加新特性。

2 changes: 1 addition & 1 deletion cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ var rootCmd = &cobra.Command{
}

func init() { //nolint:gochecknoinits
rootCmd.PersistentFlags().String("log-level", "info", "log level")
rootCmd.PersistentFlags().String("log-level", "info", "log level, options: debug, info, warn, error")

_ = viper.BindPFlag("log.level", rootCmd.PersistentFlags().Lookup("log-level"))
}
Expand Down

0 comments on commit 8aa12de

Please sign in to comment.