Updating README.md
This commit is contained in:
parent
b610c19a2f
commit
7ed91990cc
43
README.md
43
README.md
@ -1,7 +1,7 @@
|
|||||||
# Yomichan-Import #
|
# Yomichan-Import #
|
||||||
|
|
||||||
Yomichan Import is a utility which allows users of the [Yomichan Chrome](https://foosoft.net/projects/yomichan-chrome) extension to import custom
|
Yomichan Import allows users of the [Yomichan for Chrome](https://foosoft.net/projects/yomichan-chrome) extension to import custom dictionary
|
||||||
dictionary files. It currently supports the following formats:
|
files. It currently supports the following formats:
|
||||||
|
|
||||||
* [JMdict](http://www.edrdg.org/jmdict/edict_doc.html)
|
* [JMdict](http://www.edrdg.org/jmdict/edict_doc.html)
|
||||||
* [JMnedict](http://www.edrdg.org/enamdict/enamdict_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)
|
* [EPWING](https://ja.wikipedia.org/wiki/EPWING)
|
||||||
* Daijirin (三省堂 スーパー大辞林)
|
* Daijirin (三省堂 スーパー大辞林)
|
||||||
|
|
||||||
Yomichan Import is currently being expanded to support other EPWING dictionaries based on user demand. This is a mostly
|
Yomichan Import is continuously being expanded to support other EPWING dictionaries based on user demand. This is a
|
||||||
non-technical and (although laborious) process that requires writing regular expressions and creating font tables;
|
mostly non-technical and (although laborious) process that requires writing regular expressions and creating font
|
||||||
volunteer contributions are welcome.
|
tables; volunteer contributions are welcome.
|
||||||
|
|
||||||
## Installation ##
|
## 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
|
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,
|
||||||
single, combined archive. MacOS X executables will be released when I get access to Mac hardware (or somebody is nice
|
combined archive. MacOS X executables will be released at a later date, when I get access to Mac hardware (or somebody
|
||||||
enough to build [Zero-EPWING](https://foosoft.net/projects/zero-epwing) binaries for me). The packaged executables do not require installation and
|
is nice enough to build [Zero-EPWING](https://foosoft.net/projects/zero-epwing) binaries for me). The packaged executables do not require
|
||||||
do not modify your system whatsoever.
|
installation and do not modify your system in any way.
|
||||||
|
|
||||||
## Usage ##
|
## Usage ##
|
||||||
|
|
||||||
Yomichan Import is a simple command line application. When invoked without any arguments (or with `--help`), Yomichan
|
Yomichan Import is a simple command line application. When invoked without any arguments (or executed with `--help`),
|
||||||
Import will output usage instructions:
|
Yomichan Import will output usage instructions:
|
||||||
|
|
||||||
```
|
```
|
||||||
Usage: yomichan-import_linux [options] input-path [output-dir]
|
Usage: yomichan-import_linux [options] input-path [output-dir]
|
||||||
@ -44,7 +44,7 @@ Parameters:
|
|||||||
dictionary title
|
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
|
without explicitly specifying a format. Yomichan Import will attempt to automatically determine the format of the
|
||||||
dictionary based on the contents of the path:
|
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` |
|
| **kanjidic** | file named `kanjidic2.xml` |
|
||||||
| **epwing** | directory with file named `CATALOGS` |
|
| **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
|
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):
|
|
||||||
|
|
||||||
```
|
```
|
||||||
$ ./yomichan-import_linux dict/Kokugo/Daijirin/
|
$ ./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...
|
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
|
After dictionary processing is complete, Yomichan Import will start a local HTTP server to enable the Yomichan for
|
||||||
extension to retrieve the dictionary data. Windows users will likely see a firewall nag dialog at this point; access
|
Chrome extension to retrieve the dictionary data. Users of Windows will likely see a firewall nag dialog at this point;
|
||||||
must be allowed for the import process to complete:
|
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...
|
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
|
As a final step, open the Yomichan for Chrome options dialog and choose the *Local dictionary* item in the dictionary
|
||||||
drop-down menu. When you see that `http://localhost:9876/index.json` displayed in the address text-box, you can press
|
importer drop-down menu. When you see that `http://localhost:9876/index.json` displayed in the address text-box, you can
|
||||||
the *Import* button to begin the import process. Once the imported dictionary is displayed on the options screen, it is
|
press the *Import* button to begin the import process. Once the imported dictionary is displayed on the options screen,
|
||||||
safe to simply close the Yomichan Import tool.
|
it is safe to terminate the Yomichan Import tool.
|
||||||
|
|
||||||
## License ##
|
## License ##
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user