Skip to content

Commit

Permalink
Add window usage instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
dreamjz committed Nov 24, 2023
1 parent d804462 commit 8307a90
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 8 deletions.
34 changes: 29 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

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

CLI tool to auto-rename subtitle files for matched video files.
A CLI tool designed to automatically rename subtitle files corresponding to matched video files.

<!--
If you want use your Own Moe-Counter
Please refer to the tutorial
If you prefer to use your own Moe-Counter
please refer to the tutorial
in its original repo: https://github.com/journey-ad/Moe-Counter
And deploy to the replit or glitch
and deploy it to the Replit or Glitch
-->
![](https://political-capable-roll.glitch.me/get/@acgtoolssubrenamer?theme=rule34)

Expand Down Expand Up @@ -40,7 +40,31 @@ Flags:

```

### How to use on windows

1. Download the zip file and extract it to the folder you’d like.

2. Open the `cmd`: you can search for “cmd” in the Windows search bar, then click "Command Prompt"

3. Copy the path of the folder you just extracted. Input the following command and press `enter`:

```cmd
cd /d "<path you copied>"
```

4. Copy the path of the video and subtitle folder, input the following command, and press `enter`:

> **Caution: Please ensure that the video file path is provided as the first argument.**
>
> Since it will rename files in the second parameter, this process is irreversible. Creating backups for video files is otherwise cumbersome due to their large size.
```cmd
.\sub-renamer.exe "<video path>" "<subtitle path>"
```

![](./docs/assets/how_to_use.gif)

## Issue

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

30 changes: 27 additions & 3 deletions README_ZH_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ English | [简体中文](./)
自动为字幕文件匹配视频并重命名的 CLI 工具。

<!--
If you want use your Own Moe-Counter
Please refer to the tutorial
If you prefer to use your own Moe-Counter
please refer to the tutorial
in its original repo: https://github.com/journey-ad/Moe-Counter
And deploy to the replit or glitch
and deploy it to the Replit or Glitch
-->
![](https://political-capable-roll.glitch.me/get/@acgtoolssubrenamer?theme=rule34)

Expand Down Expand Up @@ -40,6 +40,30 @@ Flags:

```

### 如何在 Windows 上使用

1. 下载 zip 包,并解压到你想要的文件夹中

2. 打开 `cmd`程序:你可以在 Windows 栏中搜索 “cmd”,然后点击 “命令提示符”

3. 复制你刚才解压的文件夹路径,然后输入以下命令并按下`回车键`

```cmd
cd /d "<你复制的路径>"
```

4. 复制视频文件夹和字幕文件夹路径,然后输入以下命令并按下`回车键`

> **注意:请保证视频文件夹路径是第一个参数**
>
> 因为程序会对第二个参数中的文件进行重命名,且操作是不可逆的。并且视频文件比较大,备份起来很麻烦。
```cmd
.\sub-renamer.exe "<视频文件夹路径>" "<字幕文件夹路径>"
```

![](./docs/assets/how_to_use.gif)

## Issue

欢迎创建 issue 来报告 bug 或者 请求添加新特性。
Expand Down
Binary file added docs/assets/how_to_use.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8307a90

Please sign in to comment.