Commit 36ae2473 authored by dmMaze's avatar dmMaze
Browse files

mv readmes to doc

parent e5ea2b3d

CHANGELOG.md→doc/CHANGELOG.md

+3 −3
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ 
### 2023-01-27

[v1.3.26](https://github.com/dmMaze/BallonsTranslator/releases/tag/v1.3.26) 发布

1. 选中文本迷你菜单支持*聚合词典专业划词翻译*[沙拉查词](https://saladict.crimx.com): [安装说明](doc/saladict_chs.md)

<img src = "doc/src/saladict_doc.jpg">

<img src = "./src/saladict_doc.jpg">



2. 支持替换OCR和机翻结果中的关键字, 见编辑菜单或设置面板 [#78](https://github.com/dmMaze/BallonsTranslator/issues/78)

3. 支持拖拽导入文件夹 [#77](https://github.com/dmMaze/BallonsTranslator/issues/77)
@@ -39,7 +39,7 @@ 
4. OCR/翻译/修复选中文字区域, 填字样式会继承选中的文字框自己的

   单行文本建议选用ctc_48px, 多行日文选mangocr, 目前对多行其它语言不太行, 需要重新训练检测模型  

   注意如果用**ctc_48px**要保证框在竖排模式下且尽可能贴合单行文本

<img src="doc/src/ocrselected.gif" div align=center>

<img src="./src/ocrselected.gif" div align=center>



### 2022-11-29

[v1.3.15](https://github.com/dmMaze/BallonsTranslator/releases/tag/v1.3.15)发布
@@ -88,7 +88,7 @@ v1.3.13起支持深色模式: 视图->深色模式 
5. 文本块支持多选和**批量调整格式** (ctrl+鼠标左键或者按下右键拉框框选)

6. 支持日译英, 英译中的**自动排版**, 基于提取出的背景气泡, 目标语言为中文时会自动断句(基于pkuseg). 勾选设置面板->常规->嵌字->自动排版后将对一键机翻生效(默认启用). 



<img src="doc/src/multisel_autolayout.gif" div align=center>

<img src="./src/multisel_autolayout.gif" div align=center>

<p align=center>

批量格式调整, 英译中自动断句分行

</p>

CHANGELOG_EN.md→doc/CHANGELOG_EN.md

+3 −3
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ Src download implementation based on gallery-dl (#131) thanks to [ROKOLYT](https 
### 2023-01-27

[v1.3.26](https://github.com/dmMaze/BallonsTranslator/releases/tag/v1.3.26) released

1. Add support for [saladict](https://saladict.crimx.com) (*All-in-one professional pop-up dictionary and page translator*) in the mini menu on text selection. [Installation guide](doc/saladict.md) 

<img src = "doc/src/saladict_doc.jpg">

<img src = "./src/saladict_doc.jpg">



2. Support keyword substitution for OCR & machine translation results [#78](https://github.com/dmMaze/BallonsTranslator/issues/78): Edit -> ```Keyword substitution for machine translation```

3. Support import folder with drag&drop [#77](https://github.com/dmMaze/BallonsTranslator/issues/77)
@@ -40,7 +40,7 @@ Src download implementation based on gallery-dl (#131) thanks to [ROKOLYT](https 
   lettering style will inherit from corresponding selected block.

   ctc_48px is more recommended for single line text, mangocr for multi-line Japanese, need to retrain detection model make ctc48_px generalize to multi-lines  

   Note that if you use **ctc_48px** make sure that the box is in vertical mode and fits as close to the single line of text as possible

<img src="doc/src/ocrselected.gif" div align=center>

<img src="./src/ocrselected.gif" div align=center>



### 2022-11-29

[v1.3.15](https://github.com/dmMaze/BallonsTranslator/releases/tag/v1.3.15) released
@@ -90,7 +90,7 @@ Support Dark Mode since v1.3.13: View->Dark Mode 
5. Support multiple textblocks selection & formatting. 

6. Improved manga->English, English->Chinese typesetting (**Auto-layout** in Config panel->Lettering, enabled by default), it can also be applied to selected text blocks use the option in the right-click menu.



<img src="doc/src/multisel_autolayout.gif" div align=center>

<img src="./src/multisel_autolayout.gif" div align=center>

<p align=center>

batch text formatting & auto layout

</p>

README_EN.md→doc/README_EN.md

+9 −9
Original line number Diff line number Diff line 
# BallonTranslator

[简体中文](README.md) | English | [Русский](README_RU.md) | [日本語](README_JA.md) | [Indonesia](README_ID.md)

[简体中文](../README.md) | English | [Русский](README_RU.md) | [日本語](README_JA.md) | [Indonesia](README_ID.md)



Yet another computer-aided comic/manga translation tool powered by deep learning.



<img src="doc/src/ui0.jpg" div align=center>

<img src="./src/ui0.jpg" div align=center>



<p align=center>

preview
@@ -159,7 +159,7 @@ To use Sugoi translator(Japanese-English only), download [offline model](https:/ 
# Usage



**It is recommended to run the program in a terminal in case it crashed and left no information, see the following gif.**

<img src="doc/src/run.gif">  

<img src="./src/run.gif">  

- The first time you run the application, please select the translator and set the source and target languages by clicking the settings icon.

- Open a folder containing images of a comic (manga/manhua/manhwa) that need translation by clicking the folder icon.

- Click the `Run` button and wait for the process to complete.
@@ -169,13 +169,13 @@ The font formats such as font size and color are determined by the program autom 
## Image Editing



### Inpaint Tool

<img src="doc/src/imgedit_inpaint.gif">

<img src="./src/imgedit_inpaint.gif">

<p align = "center">

Image Editing Mode, Inpainting Tool

</p>



### rect tool

<img src="doc/src/rect_tool.gif">

<img src="./src/rect_tool.gif">

<p align = "center">

Rect Tool

</p>
@@ -184,17 +184,17 @@ To 'erase' unwanted inpainted results, use the inpainting tool or rect tool with 
The result depends on how accurately the algorithm ("method 1" and "method 2" in the gif) extracts the text mask. It could perform worse on complex text & background.  



## Text editing

<img src="doc/src/textedit.gif">

<img src="./src/textedit.gif">

<p align = "center">

Text Editing Mode

</p>



<img src="doc/src/multisel_autolayout.gif" div align=center>

<img src="./src/multisel_autolayout.gif" div align=center>

<p align=center>

Batch Text Formatting & Auto Layout

</p>



<img src="doc/src/ocrselected.gif" div align=center>

<img src="./src/ocrselected.gif" div align=center>

<p align=center>

OCR & Translate Selected Area

</p>
@@ -212,7 +212,7 @@ OCR & Translate Selected Area 
* ```Ctrl+G```/```Ctrl+F``` to search globally/in current page.

* ```0-9``` to adjust opacity of lettering layer

  

<img src="doc/src/configpanel.png">  

<img src="./src/configpanel.png">  





# Automation modules

README_ID.md→doc/README_ID.md

+9 −9
Original line number Diff line number Diff line 
# BallonTranslator

[简体中文](README.md) | [English](README_EN.md) | [Русский](README_RU.md) | [日本語](README_JA.md) | Indonesia

[简体中文](../README.md) | [English](README_EN.md) | [Русский](README_RU.md) | [日本語](README_JA.md) | Indonesia



Sebuah aplikasi penerjemahan komik/manga yang dibantu oleh deep learning.



<img src="doc/src/ui0.jpg" div align=center>

<img src="./src/ui0.jpg" div align=center>



<p align=center>

pratinjau
@@ -56,7 +56,7 @@ Untuk menggunakan Sugoi translator (hanya bahasa Jepang-Inggris), unduh [offline 


# Penggunaan

**Disarankan untuk menjalankan program di terminal jika program ini crash dan tidak meninggalkan informasi, lihat gif berikut ini**

<img src="doc/src/run.gif">  

<img src="./src/run.gif">  



- Pilih penerjemah yang diinginkan dan atur sumber dan target bahasa. 

 - Buka folder yang berisi gambar manga/manhua/webtoon yang ingin diterjemahkan.
@@ -68,13 +68,13 @@ Format font seperti ukuran font dan warna ditentukan oleh program secara otomati 
## Image editing



### inpaint tool

<img src="doc/src/imgedit_inpaint.gif">

<img src="./src/imgedit_inpaint.gif">

<p align = "center">

Mode pengeditan gambar, alat inpainting

</p>



### rect tool

<img src="doc/src/rect_tool.gif">

<img src="./src/rect_tool.gif">

<p align = "center">

Alat rect

</p>
@@ -83,17 +83,17 @@ Untuk 'menghapus' hasil inpainting yang tidak diinginkan, gunakan alat inpaintin 
Hasilnya tergantung pada seberapa akurat algoritme ("metode 1" dan "metode 2" dalam gif) mengekstrak mask dari teks. Ini berjalan lebih buruk pada teks & latar belakang yang kompleks.



## Pengeditan teks

<img src="doc/src/textedit.gif">

<img src="./src/textedit.gif">

<p align = "center">

Mode Pengeditan teks

</p>



<img src="doc/src/multisel_autolayout.gif" div align=center>

<img src="./src/multisel_autolayout.gif" div align=center>

<p align=center>

pemformatan kumpulan tata letak teks secara otomatis

</p>



<img src="doc/src/ocrselected.gif" div align=center>

<img src="./src/ocrselected.gif" div align=center>

<p align=center>

pengenalan kata & menerjemahkan area yang dipilih

</p>
@@ -110,7 +110,7 @@ pengenalan kata & menerjemahkan area yang dipilih 
* ```Ctrl++```/```Ctrl+-``` untuk mengubah ukuran gambar

* ```Ctrl+G```/```Ctrl+F``` untuk mencari secara global/dalam halaman saat ini.



<img src="doc/src/configpanel.png">  

<img src="./src/configpanel.png">  





# Modul otomasi

README_JA.md→doc/README_JA.md

+8 −8
Original line number Diff line number Diff line 
# BallonTranslator

[简体中文](README.md)| [English](README_EN.md) | [Русский](README_RU.md) | 日本語 | [Indonesia](README_ID.md)

[简体中文](../README.md)| [English](README_EN.md) | [Русский](README_RU.md) | 日本語 | [Indonesia](README_ID.md)



ディープラーニングを活用したマンガ翻訳支援ツール。



<img src="doc/src/ui0.jpg" div align=center>

<img src="./src/ui0.jpg" div align=center>



<p align=center>

プレビュー
@@ -53,7 +53,7 @@ Sugoi Translator（日英のみ）を使用するには、[オフラインモデ 
## 完全自動翻訳

**万が一、プログラムがクラッシュして情報が残らなかった場合に備えて、以下のgifを参考に、ターミナルで実行することをお勧めします。**また、初回実行時に希望するトランスレータを選択し、ソース言語とターゲット言語を設定してください。翻訳が必要な画像が入ったフォルダを開き、

「実行」ボタンをクリックして処理が完了するのを待ちます。

<img src="doc/src/run.gif">

<img src="./src/run.gif">



このとき、フォントサイズや色などのフォントフォーマットはプログラムによって自動的に決定されますが、panel->Letteringで、対応するオプションを"decide by program"から"use global setting"に変更すれば、これらのフォーマットを事前に決定できます（グローバル設定とは、シーン内の

テキストブロックを編集していないときに右フォントフォーマットパネルで表示されるフォーマットのことです）。
@@ -61,13 +61,13 @@ Sugoi Translator（日英のみ）を使用するには、[オフラインモデ 
## 画像編集



### 修復ツール

<img src="doc/src/imgedit_inpaint.gif">

<img src="./src/imgedit_inpaint.gif">

<p align = "center">

画像編集モード、修復ツール

</p>



### 長方形ツール

<img src="doc/src/rect_tool.gif">

<img src="./src/rect_tool.gif">

<p align = "center">

長方形ツール

</p>
@@ -76,12 +76,12 @@ Sugoi Translator（日英のみ）を使用するには、[オフラインモデ 
結果はアルゴリズム(gifの"方法1"と"方法2")がどれだけ正確にテキストマスクを抽出するかに依存します。複雑なテキストと背景の場合、パフォーマンスが低下する可能性があります。



## テキスト編集

<img src="doc/src/textedit.gif">

<img src="./src/textedit.gif">

<p align = "center">

テキスト編集モード

</p>



<img src="doc/src/multisel_autolayout.gif" div align=center>

<img src="./src/multisel_autolayout.gif" div align=center>

<p align=center>

テキストの一括書式設定と自動レイアウト

</p>
@@ -96,7 +96,7 @@ Sugoi Translator（日英のみ）を使用するには、[オフラインモデ 
* 設定パネルで自動モジュールのパラメータを設定します。

* 画像のサイズを変更するには、Ctrl + +/。



<img src="doc/src/configpanel.png">

<img src="./src/configpanel.png">





# Automation modules