alex/yomichan-import
1
Fork 0
Code Releases Activity

Update readme

Browse Source
This commit is contained in:
Alex Yatskov 2022-02-05 18:20:31 -08:00
parent e16da37017
commit 6b3aaf3886
1 changed files with 16 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -9,14 +9,14 @@ Collection = "ProjectsActive"
# Yomichan Import # Yomichan Import
Yomichan Import allows users of the [Yomichan](https://foosoft.net/projects/yomichan) extension to import custom dictionary files. It currently Yomichan Import allows users of the [Yomichan](https://foosoft.net/projects/yomichan) extension to import custom
supports the following formats: dictionary files. It currently supports the following formats:
* [JMdict](http://www.edrdg.org/jmdict/edict_doc.html) * [JMdict XML](http://www.edrdg.org/jmdict/edict_doc.html)
* [JMnedict](http://www.edrdg.org/enamdict/enamdict_doc.html) * [JMnedict XML](http://www.edrdg.org/enamdict/enamdict_doc.html)
* [KANJIDIC2](http://www.edrdg.org/kanjidic/kanjd2index.html) * [KANJIDIC2 XML](http://www.edrdg.org/kanjidic/kanjd2index.html)
* [Rikai](https://www.polarcloud.com/getrcx/) * [Rikai SQLite DB](https://www.polarcloud.com/getrcx/)
* [EPWING](https://ja.wikipedia.org/wiki/EPWING) * [EPWING](https://ja.wikipedia.org/wiki/EPWING):
* [Daijirin](https://en.wikipedia.org/wiki/Daijirin) (三省堂　スーパー大辞林) * [Daijirin](https://en.wikipedia.org/wiki/Daijirin) (三省堂　スーパー大辞林)
* [Daijisen](https://en.wikipedia.org/wiki/Daijisen) (大辞泉) * [Daijisen](https://en.wikipedia.org/wiki/Daijisen) (大辞泉)
* [Kenkyusha](https://en.wikipedia.org/wiki/Kenky%C5%ABsha%27s_New_Japanese-English_Dictionary) (研究社　新和英大辞典　第５版) * [Kenkyusha](https://en.wikipedia.org/wiki/Kenky%C5%ABsha%27s_New_Japanese-English_Dictionary) (研究社　新和英大辞典　第５版)
@ -31,21 +31,18 @@ contributions are welcome.
![](img/import.png) ![](img/import.png)
## Installation ## Installation and Usage
Pre-built binaries are available for Linux, Mac OS X, and Windows on the [project
page](https://github.com/FooSoft/yomichan-import/releases).
## Basic Usage
Follow the steps outlined below to import your custom dictionary into Yomichan: Follow the steps outlined below to import your custom dictionary into Yomichan:
1. Launch the `yomichan-gtk` executable after extracting the entire archive (or `yomichan` from the command line). 1. Download a pre-built binary for Linux, Mac OS X or Windows from the [project
2. Specify the source path of the dictionary you wish to convert. page](https://github.com/FooSoft/yomichan-import/releases).
3. Specify the target path of the dictionary ZIP archive that you wish to create. 2. Launch the `yomichan-gtk` executable after extracting the entire archive (or `yomichan` from the command line).
4. Press the button labeled `Import dictionary...` and wait for processing to complete. 3. Specify the source path of the dictionary you wish to convert.
5. On the Yomichan options page, browse to the dictionary ZIP archive file you created. 4. Specify the target path of the dictionary ZIP archive that you wish to create.
6. Wait for the import progress to complete before closing the options page. 5. Press the button labeled `Import dictionary...` and wait for processing to complete.
6. On the Yomichan options page, browse to the dictionary ZIP archive file you created.
7. Wait for the import progress to complete before closing the options page.
**Notice**: When converting EPWING dictionaries on Windows, it is important that the dictionary path you provide does **Notice**: When converting EPWING dictionaries on Windows, it is important that the dictionary path you provide does
not contain non-ASCII characters (including Japanese characters). This problem is due to the fact that the EPWING not contain non-ASCII characters (including Japanese characters). This problem is due to the fact that the EPWING