yomichan/README.md

48 lines
2.9 KiB
Markdown
Raw Normal View History

2016-05-19 00:03:51 +00:00
# Yomichan for Chrome #
2016-04-10 05:48:13 +00:00
2016-07-03 02:50:06 +00:00
Yomichan for Chrome turns your browser into a tool for building Japanese language literacy by helping you to decipher
texts which would be otherwise too difficult tackle. This extension was inspired in part by
2016-05-30 18:46:15 +00:00
[Rikaichan](https://addons.mozilla.org/en-US/firefox/addon/rikaichan/) and
2016-05-19 00:03:51 +00:00
[Rikaikun](https://chrome.google.com/webstore/detail/rikaikun/jipdnfibhldikgcjhfnomkfpcebammhp?hl=en), but it stands
apart in its goal of being a all-encompassing learning tool as opposed to a mere browser-based dictionary. It is the
2016-07-03 02:50:06 +00:00
natural evolution of the [Yomichan](https://foosoft.net/projects/yomichan) plugin that I developed for [Anki](http://ankisrs.net/) when I
was starting to learn Japanese back in 2011.
2016-05-30 18:46:15 +00:00
<iframe width="800" height="500" src="https://www.youtube.com/embed/90_A1VpTnMk" frameborder="0" allowfullscreen></iframe>
2016-05-19 00:03:51 +00:00
2016-07-07 03:48:19 +00:00
## Build Requirements ##
2016-07-05 06:09:39 +00:00
* [7-Zip](http://www.7-zip.org/)
* [Handlebars](http://handlebarsjs.com/)
* [Python 3](https://www.python.org/downloads/releases/3.0)
2016-05-19 00:03:51 +00:00
## Installation ##
2016-05-30 18:46:15 +00:00
The most straightforward way to install this extension is to download it from its listing in the [Chrome Web
2016-05-19 00:03:51 +00:00
Store](https://chrome.google.com/webstore/detail/yomichan/ogmnaimimemjmbakcfefmnahgdfhfami). If you are a developer, you
2016-07-03 02:50:06 +00:00
can also clone the [repository on GitHub](https://github.com/FooSoft/yomichan-chrome), provided that you have have [Git
LFS](https://git-lfs.github.com/) installed (it is required to download the included dictionary files).
2016-05-30 18:46:15 +00:00
If you wish to make use of the *AnkiConnect* functionality to create Japanese flash cards directly from your browser,
you must install the [AnkiConnect](https://foosoft.net/projects/anki-connect) extension first. If you already have
2016-07-03 02:50:06 +00:00
[Yomichan](https://foosoft.net/projects/yomichan) installed, AnkiConnect can be used after it is enabled in the plugin preferences.
2016-05-19 00:03:51 +00:00
## Usage ##
1. Click on the Yomichan browser action button in the upper right corner of the window (labeled ヨミ).
2016-05-30 18:46:15 +00:00
2. Hold down the <kbd>Shift</kbd> or the middle mouse button while you move your mouse over Japanese text.
2016-05-19 00:03:51 +00:00
3. Resize the definition window by dragging the bottom right corner of the window.
4. Clicking on a Kanji will display the Kanji information page, including a Kanji stroke diagram.
2016-07-03 02:50:06 +00:00
5. Users of [AnkiConnect](https://foosoft.net/projects/anki-connect) will see buttons that can be used to create new flash cards.
2016-05-19 00:03:51 +00:00
6. Right click on the Yomichan browser action button and select *Options* to configure the extension.
## Screenshots ##
2016-07-03 02:50:06 +00:00
[![Vocabulary definitions](https://foosoft.net/projects/yomichan-chrome/img/vocab-thumb.png)](https://foosoft.net/projects/yomichan-chrome/img/vocab.png)
[![Kanji information](https://foosoft.net/projects/yomichan-chrome/img/kanji-thumb.png)](https://foosoft.net/projects/yomichan-chrome/img/kanji.png)
[![Options page](https://foosoft.net/projects/yomichan-chrome/img/options-thumb.png)](https://foosoft.net/projects/yomichan-chrome/img/options.png)
2016-06-11 23:01:32 +00:00
2016-05-19 00:03:51 +00:00
## License ##
GPL