alex/yomichan-anki
1
Fork 0
Code Releases Activity

Updating README.md

Browse Source
This commit is contained in:
Alex Yatskov 2017-02-26 15:08:34 -08:00
parent 5372aa725f
commit 7eddc6d34a
1 changed files with 10 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -2,15 +2,15 @@
Yomichan is an Anki plugin built to help students of Japanese learn the language by reading native media on their Yomichan is an Anki plugin built to help students of Japanese learn the language by reading native media on their
computer. This application's one-click flash card creation feature makes vocabulary mining trivial, allowing you to computer. This application's one-click flash card creation feature makes vocabulary mining trivial, allowing you to
focus on enjoying your reading. Yomichan can be used in conjunction with [Yomichan for focus on enjoying your reading.
Chrome](https://foosoft.net/projects/yomichan-chrome) to further enhance your learning experience by enabling flash card creation from your
web browser. *Note: This project is no longer maintained and has been superseded by the [Yomichan](https://foosoft.net/projects/yomichan/) browser extension*.
## Requirements ## ## Requirements ##
For running: For running:
* [Anki](http://ankisrs.net/) * [Anki](http://ankisrs.net/) (versions 2.0.x)
For building: For building:
@ -22,28 +22,28 @@ For building:
## Installation ## ## Installation ##
Yomichan can be downloaded from the its [Anki shared addon page](https://ankiweb.net/shared/info/934748696). After it is Yomichan can be downloaded from the [Anki shared addon page](https://ankiweb.net/shared/info/934748696). This plugin
installed, this plugin will automatically notify you when new versions are available. will automatically notify you when updates are available.
## Usage ## ## Usage ##
1. Make sure you are running the latest version of Anki. 1. Make sure you are running the latest version of Anki.
2. Open your vocab deck and note the fields that are used in your deck. 2. Open your vocab deck and note the fields that are used in your deck.
[![Card layout dialog](https://foosoft.net/projects/yomichan/img/layout-thumb.png)](https://foosoft.net/projects/yomichan/img/layout.png) [![Card layout dialog](https://foosoft.net/projects/yomichan-anki/img/layout-thumb.png)](https://foosoft.net/projects/yomichan-anki/img/layout.png)
3. Launch Yomichan from the tools menu inside Anki. 3. Launch Yomichan from the tools menu inside Anki.
4. Open the text file you want and you will see its contents in the Yomichan. Your layout and color scheme will look 4. Open the text file you want and you will see its contents in the Yomichan. Your layout and color scheme will look
different because the screenshot shows my personal settings. different because the screenshot shows my personal settings.
[![Reader dialog](https://foosoft.net/projects/yomichan/img/reader-thumb.png)](https://foosoft.net/projects/yomichan/img/reader.png) [![Reader dialog](https://foosoft.net/projects/yomichan-anki/img/reader-thumb.png)](https://foosoft.net/projects/yomichan-anki/img/reader.png)
5. To look up words hover your mouse over them while pressing the middle mouse button (usually this is your scroll 5. To look up words hover your mouse over them while pressing the middle mouse button (usually this is your scroll
wheel). You can also press and hold shift instead if you like (or your mouse has no center button). wheel). You can also press and hold shift instead if you like (or your mouse has no center button).
6. To set up your Anki deck for Yomichan select Preferences from the Edit menu and you should see a screen that looks 6. To set up your Anki deck for Yomichan select Preferences from the Edit menu and you should see a screen that looks
like this: like this:
[![Preferences dialog](https://foosoft.net/projects/yomichan/img/preferences-thumb.png)](https://foosoft.net/projects/yomichan/img/preferences.png) [![Preferences dialog](https://foosoft.net/projects/yomichan-anki/img/preferences-thumb.png)](https://foosoft.net/projects/yomichan-anki/img/preferences.png)
7. Now you should add markers such as `{expression}`, `{reading}`, `{reading}` and `{sentence}` to specify how new 7. Now you should add markers such as `{expression}`, `{reading}`, `{reading}` and `{sentence}` to specify how new
cards should be created. Card fields will vary depending on your deck model. If you want to be able to use cards should be created. Card fields will vary depending on your deck model. If you want to be able to use
@ -54,7 +54,7 @@ installed, this plugin will automatically notify you when new versions are avail
Anki thinks you can't add a fact with those items*. This likely means that they would either be duplicates of Anki thinks you can't add a fact with those items*. This likely means that they would either be duplicates of
existing cards in the deck or that Yomichan hasn't been properly set up for your deck model. existing cards in the deck or that Yomichan hasn't been properly set up for your deck model.
[![Icons](https://foosoft.net/projects/yomichan/img/icons-thumb.png)](https://foosoft.net/projects/yomichan/img/icons.png) [![Icons](https://foosoft.net/projects/yomichan-anki/img/icons-thumb.png)](https://foosoft.net/projects/yomichan-anki/img/icons.png)
Here is what the icons mean (in order from left to right): Here is what the icons mean (in order from left to right):
* Add term in Kana form even it can be written in Kanji (e.g. べんきょうか). * Add term in Kana form even it can be written in Kanji (e.g. べんきょうか).
@ -74,13 +74,6 @@ Yomichan features several keyboard shortcuts for ease of use:
| <kbd>Ctrl</kbd> + <kbd>#</kbd> | Add current term at index 0 - 9 to deck | | <kbd>Ctrl</kbd> + <kbd>#</kbd> | Add current term at index 0 - 9 to deck |
| <kbd>Alt</kbd> + <kbd>#</kbd> | Add current term at index 0 - 9 to deck as Hiragana | | <kbd>Alt</kbd> + <kbd>#</kbd> | Add current term at index 0 - 9 to deck as Hiragana |
### AnkiConnect ###
AnkiConnect is a convenient feature, which enables external applications to communicate directly with Anki, thus
allowing them to query decks and create new flash cards without user involvement. This feature must be enabled through
the preference dialog prior to use. AnkiConnect is also available as a [separate plugin](https://foosoft.net/projects/anki-connect/) for
those who want to get this feature in a smaller package.
### Importing Vocabulary ### ### Importing Vocabulary ###
Yomichan is capable of importing vocabulary lists from plain text files and the vocabulary deck database the Amazon Yomichan is capable of importing vocabulary lists from plain text files and the vocabulary deck database the Amazon