alex/yomichan-import
1
Fork 0
Code Releases Activity

Updating README.md

Browse Source
This commit is contained in:
Alex Yatskov 2016-12-29 23:04:19 -08:00
parent b610c19a2f
commit 7ed91990cc
1 changed files with 21 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -1,7 +1,7 @@
# Yomichan-Import #
Yomichan Import is a utility which allows users of the [Yomichan Chrome](https://foosoft.net/projects/yomichan-chrome) extension to import custom
dictionary files. It currently supports the following formats:
Yomichan Import allows users of the [Yomichan for Chrome](https://foosoft.net/projects/yomichan-chrome) extension to import custom dictionary
files. It currently supports the following formats:
* [JMdict](http://www.edrdg.org/jmdict/edict_doc.html)
* [JMnedict](http://www.edrdg.org/enamdict/enamdict_doc.html)
@ -9,21 +9,21 @@ dictionary files. It currently supports the following formats:
* [EPWING](https://ja.wikipedia.org/wiki/EPWING)
* Daijirin (三省堂　スーパー大辞林)
Yomichan Import is currently being expanded to support other EPWING dictionaries based on user demand. This is a mostly
non-technical and (although laborious) process that requires writing regular expressions and creating font tables;
volunteer contributions are welcome.
Yomichan Import is continuously being expanded to support other EPWING dictionaries based on user demand. This is a
mostly non-technical and (although laborious) process that requires writing regular expressions and creating font
tables; volunteer contributions are welcome.
## Installation ##
Yomichan Import is currently available for Linux and Windows and can be [downloaded](https://foosoft.net/projects/yomichan-import/dl/yomichan-import.tar.gz) in a
single, combined archive. MacOS X executables will be released when I get access to Mac hardware (or somebody is nice
enough to build [Zero-EPWING](https://foosoft.net/projects/zero-epwing) binaries for me). The packaged executables do not require installation and
do not modify your system whatsoever.
Yomichan Import is available for Linux and Windows and can be [downloaded](https://foosoft.net/projects/yomichan-import/dl/yomichan-import.tar.gz) in a single,
combined archive. MacOS X executables will be released at a later date, when I get access to Mac hardware (or somebody
is nice enough to build [Zero-EPWING](https://foosoft.net/projects/zero-epwing) binaries for me). The packaged executables do not require
installation and do not modify your system in any way.
## Usage ##
Yomichan Import is a simple command line application. When invoked without any arguments (or with `--help`), Yomichan
Import will output usage instructions:
Yomichan Import is a simple command line application. When invoked without any arguments (or executed with `--help`),
Yomichan Import will output usage instructions:
```
Usage: yomichan-import_linux [options] input-path [output-dir]
@ -44,7 +44,7 @@ Parameters:
dictionary title
```
In the vast majority of cases it should sufficient to provide the path to the dictionary resource you wish to process,
In the vast majority of cases it is enough 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:
@ -55,31 +55,30 @@ dictionary based on the contents of the path:
| **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
(assuming that you are running the Linux executable):
For example, if you wanted to process an EPWING dictionary titled Daijirin, you could do so with the following command:
```
$ ./yomichan-import_linux dict/Kokugo/Daijirin/
```
Yomichan Import will begin the conversion process, which can take a couple of minutes to complete:
Yomichan Import will now begin the conversion process, which can take a couple of minutes to complete:
```
2016/12/29 17:12:12 converting 'dict/Kokugo/Daijirin/' to '/tmp/yomichan_tmp_825860502' in 'epwing' format...
```
After the processing is complete, Yomichan Import will start a local HTTP server which enables the Yomichan Chrome
extension to retrieve the dictionary data. Windows users will likely see a firewall nag dialog at this point; access
must be allowed for the import process to complete:
After dictionary processing is complete, Yomichan Import will start a local HTTP server to enable the Yomichan for
Chrome extension to retrieve the dictionary data. Users of Windows will likely see a firewall nag dialog at this point;
access must be granted in order to make dictionary data accessible to the extension.
```
2016/12/29 17:12:20 starting dictionary server on port 9876...
```
Finally, open the Yomichan Chrome options dialog and select the *Local dictionary* item in the dictionary importer
drop-down menu. When you see that `http://localhost:9876/index.json` displayed in the address text-box, you can press
the *Import* button to begin the import process. Once the imported dictionary is displayed on the options screen, it is
safe to simply close the Yomichan Import tool.
As a final step, open the Yomichan for Chrome options dialog and choose the *Local dictionary* item in the dictionary
importer drop-down menu. When you see that `http://localhost:9876/index.json` displayed in the address text-box, you can
press the *Import* button to begin the import process. Once the imported dictionary is displayed on the options screen,
it is safe to terminate the Yomichan Import tool.
## License ##