From 4284a12bac072b7b6611b32d4a9e6fcc29026d64 Mon Sep 17 00:00:00 2001 From: Alex Yatskov Date: Wed, 18 May 2016 17:03:51 -0700 Subject: Adding README.md --- README.md | 39 +++++++++++++++++++++++++++++++++++++-- img/kanji-thumb.png | Bin 0 -> 17229 bytes img/kanji.png | Bin 0 -> 314980 bytes img/options-thumb.png | Bin 0 -> 3587 bytes img/options.png | Bin 0 -> 50647 bytes img/vocab-thumb.png | Bin 0 -> 16959 bytes img/vocab.png | Bin 0 -> 309681 bytes 7 files changed, 37 insertions(+), 2 deletions(-) create mode 100644 img/kanji-thumb.png create mode 100644 img/kanji.png create mode 100644 img/options-thumb.png create mode 100644 img/options.png create mode 100644 img/vocab-thumb.png create mode 100644 img/vocab.png diff --git a/README.md b/README.md index 66d0fb86..6b7ce5fc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,38 @@ -# yomichan-chrome +# Yomichan for Chrome # -Japanese dicionary lookup extension for Chrome with Anki support. +The Yomichan extension for Chrome allows you to turn Chrome into a tool for building Japanese language literacy +(regardless of current skill level), aiding in deciphering texts which would be otherwise too difficult tackle. This +browser extension was inspired in part by [Rikaichan](https://addons.mozilla.org/en-US/firefox/addon/rikaichan/) and +[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 +natural evolution of the [Yomichan](/projects/yomichan) plugin that I developed for [Anki](http://ankisrs.net/) back in +2011 and the two applications can be used together in order to automatically generate flash cards for new vocabulary and +Kanji encountered during reading. + +## Installation ## + +The easiest way to install this extension is to download it from its listing in the [Chrome Web +Store](https://chrome.google.com/webstore/detail/yomichan/ogmnaimimemjmbakcfefmnahgdfhfami). If you are a developer, you +can also clone the [repository on GitHub](https://github.com/FooSoft/yomichan-chrome-ext), provided that you have have +installed [Git LFS](https://git-lfs.github.com/) and have initialized the included submodule dependencies after pulling +down the main project. If you wish to use this extension alongside Anki, please read and follow the installation +instructions for the [Yomichan](/projects/yomichan) plugin. + +## Usage ## + +1. Click on the Yomichan browser action button in the upper right corner of the window (labeled ヨミ). +2. Hold down the `Shift` or the middle mouse button while you move your mouse over Japanese text. +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. +5. If you are using [AnkiConnect](/projects/yomichan), you will see buttons that can be used to create flash cards. +6. Right click on the Yomichan browser action button and select *Options* to configure the extension. + +## Screenshots ## + +[![Vocabulary definitions](img/vocab-thumb.png)](img/vocab.png) +[![Kanji information](img/kanji-thumb.png)](img/kanji.png) +[![Options page](img/options-thumb.png)](img/options.png) + +## License ## + +GPL diff --git a/img/kanji-thumb.png b/img/kanji-thumb.png new file mode 100644 index 00000000..92f48323 Binary files /dev/null and b/img/kanji-thumb.png differ diff --git a/img/kanji.png b/img/kanji.png new file mode 100644 index 00000000..930cdc75 Binary files /dev/null and b/img/kanji.png differ diff --git a/img/options-thumb.png b/img/options-thumb.png new file mode 100644 index 00000000..f58a16b1 Binary files /dev/null and b/img/options-thumb.png differ diff --git a/img/options.png b/img/options.png new file mode 100644 index 00000000..4c638a8d Binary files /dev/null and b/img/options.png differ diff --git a/img/vocab-thumb.png b/img/vocab-thumb.png new file mode 100644 index 00000000..df19dd50 Binary files /dev/null and b/img/vocab-thumb.png differ diff --git a/img/vocab.png b/img/vocab.png new file mode 100644 index 00000000..e2c939cc Binary files /dev/null and b/img/vocab.png differ -- cgit v1.2.3