Skip to content

Commit

Permalink
<docs> update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
anonymousException committed Jan 22, 2024
1 parent da2e759 commit 44e3d8b
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,24 @@

<div align=center><img src = "https://github.com/anonymousException/renpy-translator/blob/main/docs/img/interface.png"></div>

<div align=center><img src = "https://github.com/anonymousException/renpy-translator/blob/main/docs/img/interface.png"></div>

------

## Target

As you see the above translated contents. The original contents will be remained after translation.

If the contents are short of the original contents(behind the "#" as comment) , translation will not take effect on them

The reason why I made this tool is not to replace the real translator's work , but to help.

The translated contents will be not accurate enough due to auto google translation.

So the original contents will do the effect. You can re-translate the translated contents according to the original contents. And what you modified will not be replaced during next translation.

This tool also take care of the special symbols like "{}" "[]" and "<>" in untranslated contents , for detail you can see it on the [Features point 2](#jump_features)

## Another Docs

### Chinese
Expand All @@ -22,7 +38,7 @@

You can download the latest version through https://github.com/anonymousException/renpy-translator/releases/latest

## Features
## <span id ="jump_features">Features</span>

- Completely free and open-source
- Support **special symbols** in untranslated contents like "{}" "[]" and "<>" , the contents in special symbols will not be translated. Example:
Expand Down
18 changes: 18 additions & 0 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,24 @@

------

<div align=center><img src = "https://github.com/anonymousException/renpy-translator/blob/main/docs/img/interface.png"></div>

------

## 目的

正如你所见上方翻译后的内容,在翻译后被翻译的原文也会被保留

如果要被翻译的内容缺少原内容(在"#"后作为注释),那么这些内容将被跳过不被翻译

我做这个工具的目的不是为了替代人工翻译,而是帮助

翻译的内容通常因为机翻而不够准确

因此这时原文的作用就来了,你可以根据原文重写翻译,并且你修改后的内容也不会在后面的翻译里再被替换掉

本工具也处理了被翻译文本种包含特殊符号的场景,像 "{}" "[]" 和 "<>" ,具体可以前往 [特性的第 2 点](#jump_features)

## 下载

你可以通过 https://github.com/anonymousException/renpy-translator/releases/latest 下载最新版本
Expand Down
Binary file added docs/img/translated_contents.png
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 44e3d8b

Please sign in to comment.