doc

HIllya51 · Jul 3, 2024 · 57893c1 · 57893c1
1 parent 46e07ab
commit 57893c1
Show file tree

Hide file tree

Showing 19 changed files with 153 additions and 383 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# LunaTranslator 
+## LunaTranslator 
 
 <p align="left">
     <a href="./LICENSE"><img src="https://img.shields.io/github/license/HIllya51/LunaTranslator"></a>
@@ -7,14 +7,14 @@
     <a href="https://github.com/HIllya51/LunaTranslator/releases/latest/download/LunaTranslator.zip" target="_blank"><img src="https://img.shields.io/badge/download_64bit-blue"/></a> <a href="https://github.com/HIllya51/LunaTranslator/releases/latest/download/LunaTranslator_x86.zip" target="_blank"><img src="https://img.shields.io/badge/download_32bit-blue"/></a>
 </p>
 
-## 简体中文 | [Русский язык](README_ru.md) | [English](README_en.md) | [Other Language](otherlang.md) 
+### 简体中文 | [Русский язык](README_ru.md) | [English](README_en.md) | [Other Language](otherlang.md) 
 
 > **一款galgame翻译器**
 
-#### <a href="https://hillya51.github.io/LunaTranslator/#/zh/" target="_blank">使用说明</a> <a href="https://space.bilibili.com/592120404/video" target="_blank">视频教程</a> [交流群912525396](https://qm.qq.com/q/qE32v9NYBO)
+### <a href="https://hillya51.github.io/LunaTranslator/#/zh/" target="_blank">使用说明</a> <a href="https://space.bilibili.com/592120404/video" target="_blank">视频教程</a> [交流群912525396](https://qm.qq.com/q/qE32v9NYBO)
 
 
-## 功能支持
+### 功能支持
 
 #### 文本源
 
@@ -62,7 +62,7 @@
 
 &emsp;&emsp;**Anki** 支持使用一键添加单词到anki中
 
-## 引用
+### 引用
 
 <details>
 <summary>点击查看</summary>
@@ -93,7 +93,7 @@
 
 
 
-## 支持作者
+### 支持作者
 
 如果你感觉该软件对你有帮助，欢迎微信扫码赞助，谢谢，么么哒~
 

diff --git a/README_en.md b/README_en.md
@@ -1,20 +1,20 @@
-# LunaTranslator 
+## LunaTranslator 
 
 <p align="left">
     <a href="./LICENSE"><img src="https://img.shields.io/github/license/HIllya51/LunaTranslator"></a>
     <a href="https://github.com/HIllya51/LunaTranslator/releases"><img src="https://img.shields.io/github/v/release/HIllya51/LunaTranslator?color=ffa"></a>
     <a href="https://github.com/HIllya51/LunaTranslator/stargazers"><img src="https://img.shields.io/github/stars/HIllya51/LunaTranslator?color=ccf"></a>
 </p>
 
-## [简体中文](README.md) | [Русский язык](README_ru.md) |  English | [Other Language](otherlang.md) 
+### [简体中文](README.md) | [Русский язык](README_ru.md) |  English | [Other Language](otherlang.md) 
 
 > **A galgame translator**
 
-## <a href="https://hillya51.github.io/LunaTranslator/#/en/" target="_blank">Documentation</a> 
+### <a href="https://hillya51.github.io/LunaTranslator/#/en/" target="_blank">Documentation</a> 
 
 Welcome friends who find it helpful to improve the documentation together.[Documentation Repo](https://github.com/HIllya51/LunaTranslator)
 
-## Function support
+### Function support
 
 #### Text source
 
@@ -61,7 +61,7 @@ Support almost all translation engines you can think of, including:
 
 
 
-## References
+### References
 
 <details>
 <summary>Click to view</summary>
@@ -90,6 +90,6 @@ Support almost all translation engines you can think of, including:
 
 
 
-## Support author
+### Support author
 
 If you feel that the software is helpful to you, welcome to become my [sponsor](https://patreon.com/HIllya51). Thank you ~ 
diff --git a/README_ru.md b/README_ru.md
@@ -1,21 +1,21 @@
-# LunaTranslator 
+## LunaTranslator 
 
 <p align="left">
     <a href="./LICENSE"><img src="https://img.shields.io/github/license/HIllya51/LunaTranslator"></a>
     <a href="https://github.com/HIllya51/LunaTranslator/releases"><img src="https://img.shields.io/github/v/release/HIllya51/LunaTranslator?color=ffa"></a>
     <a href="https://github.com/HIllya51/LunaTranslator/stargazers"><img src="https://img.shields.io/github/stars/HIllya51/LunaTranslator?color=ccf"></a>
 </p>
 
-## [简体中文](README.md)  |  Русский язык | [English](README_en.md) | [Other Language](otherlang.md) 
+### [简体中文](README.md)  |  Русский язык | [English](README_en.md) | [Other Language](otherlang.md) 
 
 > **Переводчик текста с экрана для игр и не только!**
 
 
-## <a href="https://hillya51.github.io/LunaTranslator/#/ru/" target="_blank">Инструкция по настройке программы (Полностью на русском языке)</a> 
+### <a href="https://hillya51.github.io/LunaTranslator/#/ru/" target="_blank">Инструкция по настройке программы (Полностью на русском языке)</a> 
 
 Welcome friends who find it helpful to improve the documentation together.[Documentation Repo](https://github.com/HIllya51/LunaTranslator)
 
-## Основные функции:
+### Основные функции:
 
 #### Источник текста
 
@@ -58,7 +58,7 @@ Welcome friends who find it helpful to improve the documentation together.[Docum
 
 &emsp;&emsp;**Поиск слов** Поддерживает поиск слов с использованием Xiaoxiaoguan, Lingoes Dictionary и EDICT (японо-английский словарь).
 
-## Скачать дополнительные файлы:
+### Скачать дополнительные файлы:
 
 <details>
 <summary>Нажмите на детали</summary>
@@ -85,13 +85,13 @@ Welcome friends who find it helpful to improve the documentation together.[Docum
 
 </details>
 
-##  Отдельная благодарность: 
+###  Отдельная благодарность: 
 
 
 * [@KirpichKrasniy](https://github.com/KirpichKrasniy) (Также можете зайти в русскоязычные сообщества программы: [VK](https://vk.com/lunatranslator) и [Telegram](https://t.me/LunaTranslator))
 
 
-## References
+### References
 
 <details>
 <summary>Click to view</summary>

diff --git a/docs/zh/README.md b/docs/zh/README.md
@@ -1,5 +1,5 @@
 
-# LunaTranslator 使用说明
+## LunaTranslator 使用说明
 
 <p align="left">
     <a href="./LICENSE"><img src="https://img.shields.io/github/license/HIllya51/LunaTranslator"></a>
@@ -8,10 +8,10 @@
     <a href="https://github.com/HIllya51/LunaTranslator/releases/latest/download/LunaTranslator.zip" target="_blank"><img src="https://img.shields.io/badge/download_64bit-blue"/></a> <a href="https://github.com/HIllya51/LunaTranslator/releases/latest/download/LunaTranslator_x86.zip" target="_blank"><img src="https://img.shields.io/badge/download_32bit-blue"/></a>
 </p>
 
-<a href="https://hillya51.github.io/LunaTranslator/#/zh/" target="_blank">使用说明</a> <a href="https://space.bilibili.com/592120404/video" target="_blank">视频教程</a>  <a href="https://qm.qq.com/q/qE32v9NYBO" target="_blank">交流群912525396</a>
+### <a href="https://hillya51.github.io/LunaTranslator/#/zh/" target="_blank">使用说明</a> <a href="https://space.bilibili.com/592120404/video" target="_blank">视频教程</a>  <a href="https://qm.qq.com/q/qE32v9NYBO" target="_blank">交流群912525396</a>
 
 
-## 功能支持
+### 功能支持
 
 #### 文本源
 

diff --git a/docs/zh/basicuse.md b/docs/zh/basicuse.md
@@ -1,5 +1,5 @@
 
-# 最基本的使用
+## 最基本的使用
 
 启动后的界面如下。
 

diff --git a/docs/zh/hooksetsumei.md b/docs/zh/hooksetsumei.md
diff --git a/docs/zh/ocrsetsumei.md b/docs/zh/ocrsetsumei.md
diff --git a/docs/zh/qa1.md b/docs/zh/qa1.md
@@ -0,0 +1,14 @@
+## 如何使用 Mecab 分词&词性颜色标注
+
+首先需要下载mecab词典，任选其一下载，解压
+
+![img](../images/zh/mecab_download.png)
+
+然后在辞书设置中激活mecab，并设置词典路径
+
+![img](../images/zh/mecab.png)
+
+然后，在显示设置->显示内容中，激活分词注音显示和语法加亮
+
+![img](../images/zh/fenci.png)
+
diff --git a/docs/zh/qa2.md b/docs/zh/qa2.md
@@ -0,0 +1,31 @@
+## 如何自动划词进 anki
+
+1. 安装 anki, https://apps.ankiweb.net/ 去主页下载安装
+
+2. 搜 anki connect 第一条
+
+![img](../images/zh/anki/336449205-4eb7ce93-a9e9-489b-be8a-da67cfdca6ea.png)
+
+会提供一个数字，当前是 2055492159.
+
+3.
+
+![img](../images/zh/anki/336449710-95f90d9a-cfe6-42c3-a44f-64d88d13833d.png)
+
+4.
+
+![img](../images/zh/anki/336450025-9bf64445-f62e-4bfe-86f7-da99a7100e92.png)
+
+填入数字，重启 anki
+
+<hr>
+
+在 luna 这边，点击查词后。
+
+
+
+![img](../images/zh/anki/336451202-a2dd54c0-e4ee-4c27-9183-8b4ab05c4819.png)
+
+![img](../images/zh/anki/336451442-7887d600-8c44-4256-9020-1d85e0f6184a.png)
+
+[^1]: [asukaminato0721](https://github.com/HIllya51/LunaTranslator/issues/796)
diff --git a/docs/zh/qa3.md b/docs/zh/qa3.md
@@ -0,0 +1,22 @@
+## 如何使用离线 chatgpt
+
+需要在本地或者 ~~ssh 转发端口到本地(能看懂这句话那不需要继续了)~~
+
+仅提供一种解法。别的兼容 gpt api 的都可以。
+
+下载 ollama https://www.ollama.com/
+
+以 llama3 举例。
+
+https://www.ollama.com/library/llama3
+
+下载好模型，后台跑起来后，在
+
+![img](../images/zh/336483101-915f17c5-27a4-465f-9b4e-7a547ba5029f.png)
+
+改成自己在跑的模型，端口改成对应的。就行了。
+
+>PS: 建议使用 https://github.com/SakuraLLM/SakuraLLM/wiki
+使用llama.cpp部署，最简单。然后使用sakura大模型的专用接口，里面有一些模型作者写的prompt。
+
+[^1]: [asukaminato0721](https://github.com/HIllya51/LunaTranslator/issues/797)
diff --git a/docs/zh/qa4.md b/docs/zh/qa4.md
@@ -0,0 +1,42 @@
+## 如何使用 gemini 免费 api
+
+1. 去 https://aistudio.google.com/app/prompts/new_chat
+2. 
+
+![img](../images/zh/gemini/344549401-33da8fae-fafb-4f88-afb1-967b91f7ca4b.png)
+
+![img](../images/zh/gemini/344549459-b688a3be-5b2a-4d6a-bf56-dc7d45bc5ee9.png)
+
+
+随便新建一个项目并生成 api key.
+
+<hr>
+
+打开 luna 翻译器
+
+![img](../images/zh/gemini/344549959-4e18dec9-658c-4df1-a0e7-d2379503e604.png)
+
+勾上，齿轮点开
+
+![img](../images/zh/gemini/344550089-518d6afa-7818-445d-be16-5770d196b489.png)
+
+<hr>
+
+注意点：
+
+1. 翻译 NSFW 内容会拒绝翻译
+2. 频率高了会报错，需要等一会
+但是是免费的。
+
+模型可以选别的，但是 pro 的频率更低。
+
+效果预览
+
+![img](../images/zh/gemini/344550450-e4d25242-e679-45c5-8412-df07fc972843.png)
+
+目前有下列模型
+
+![img](../images/zh/gemini/344551043-a0b058b0-e7e8-49c2-a8a4-3201db78ddec.png)
+
+
+[^1]: [asukaminato0721](https://github.com/HIllya51/LunaTranslator/issues/863)
diff --git a/docs/zh/qas.md b/docs/zh/qas.md