alex/yomichan-import
1
Fork 0
Code Releases Activity

Updating README.md

Browse Source
This commit is contained in:
Alex Yatskov 2017-06-26 20:35:41 -07:00
parent 00acc56076
commit b6da9704fd
1 changed files with 9 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
README.md
View File

@ -19,76 +19,25 @@ contributions are welcome.
## Installation ##
Builds of Yomichan Import are currently available for Linux, Mac OS X, and Windows. The required version of
Builds of Yomichan Import are currently available for Linux, Mac OS X, and Windows. The necessary version of
[Zero-EPWING](https://foosoft.net/projects/zero-epwing) is included for processing EPWING dictionaries.
* [yomichan-import_linux.tar.gz](https://foosoft.net/projects/yomichan-import/dl/yomichan-import_linux.tar.gz): (GTK+ 3 required for GUI)
* [yomichan-import_darwin.tar.gz](https://foosoft.net/projects/yomichan-import/dl/yomichan-import_darwin.tar.gz)
* [yomichan-import_windows.zip](https://foosoft.net/projects/yomichan-import/dl/yomichan-import_windows.zip) (64 bit Vista or above, no console output)
## Using the Graphical Interface ##
## Basic Usage ##
In most cases, it is sufficient to run the application without command line arguments and use the graphical interface.
Follow the steps below to import your dictionary into Yomichan:
Please follow the steps outlined below to import your custom dictionary into Yomichan:
1. Launch the `yomichan-import` executable.
2. Specify the path to the dictionary you wish to convert (path to `CATALOGS` file for EPWING dictionaries).
3. Specify a network port to use (the default port `9876` should be fine for most configurations).
4. Specify the dictionary format from the provided options.
5. Press the button labeled *Import dictionary...* and wait for processing to complete.
6. Once you the message `starting dictionary server on port 9876...`, the dictionary data is ready to be imported.
7. In Yomichan, open the options page and select the *Local dictionary* item in the dictionary importer drop-down menu.
8. When `http://localhost:9876/index.json` is displayed in the address text-box, press the *Import* button to begin import.
9. Wait for the import progress to complete (a progress bar is displayed during dictionary processing).
9. Close Yomichan Import once the import process has finished.
2. Specify the source path of the dictionary you wish to convert.
3. Specify the target path of the dictionary ZIP archive that you wish to create.
4. Press the button labeled *Import dictionary...* and wait for processing to complete.
5. On the Yomichan options page, browse to the dictionary ZIP archive file you created.
6. Wait for the import progress to complete before closing the options page.
[![Import window](https://foosoft.net/projects/yomichan-import/img/import-thumb.png)](https://foosoft.net/projects/yomichan-import/img/import.png)
## Using the Command Line ##
Yomichan Import can be used as a command line application. When executed with the `--help` argument, usage instructions
will be displayed (except on Windows).
```
Usage: yomichan-import [options] input-path [output-dir]
https://foosoft.net/projects/yomichan-import/
Parameters:
-format string
dictionary format [edict|enamdict|kanjidic|epwing]
-port int
port to serve dictionary JSON on (default 9876)
-pretty
output prettified dictionary JSON
-serve
serve dictionary JSON for extension
-stride int
dictionary bank stride (default 10000)
-title string
dictionary title
```
In most cases it is sufficient to simply provide the path to the dictionary resource you wish to process, without
explicitly specifying a format. Yomichan Import will attempt to automatically determine the format of the dictionary
based on the contents of the path:
| Format | Resource |
| ------------ | ------------------------------------ |
| **edict** | file named `JMDict_e.xml` |
| **enamdict** | file named `JMNedict.xml` |
| **kanjidic** | file named `kanjidic2.xml` |
| **epwing** | directory with file named `CATALOGS` |
For example, if you wanted to process an EPWING dictionary titled Daijirin, you could do so with the following command
(shown on Linux):
```
$ ./yomichan-import dict/Kokugo/Daijirin/
```
Yomichan Import will now begin the conversion process, which can take a couple of minutes to complete. Once you see the
message `starting dictionary server on port 9876...` output to your console, you can use Yomichan to import the
processed dictionary data using the same steps as described in the *Using the Graphical Interface* section.
[![Importer](https://foosoft.net/projects/yomichan-import/img/import-thumb.png)](https://foosoft.net/projects/yomichan-import/img/import.png)
## License ##