alex/yomichan-anki
1
Fork 0
Code Releases Activity

Updating README.md

Browse Source
This commit is contained in:
Alex Yatskov 2016-07-06 22:39:04 -07:00
parent 8e0680182f
commit 4cdcd1a85d
1 changed files with 20 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -1,26 +1,30 @@
# Yomichan # # Yomichan #
Yomichan is an [Anki](http://ankisrs.net/) plugin built to solve the various annoyances I encountered when trying to Yomichan is an Anki plugin built to help students of Japanese learn the language by reading native media on their
read Japanese books on my computer. This tool makes vocabulary mining trivial by allowing you to focus on your reading. computer. This application's one-click flash card creation feature makes vocabulary mining trivial, allowing you to
Yomichan can be used in conjunction with [Yomichan for Chrome](https://foosoft.net/projects/yomichan-chrome) to further enhance your focus on enjoying your reading. Yomichan can be used in conjunction with [Yomichan for
learning experience by enabling flash card creation from your web browser. Chrome](https://foosoft.net/projects/yomichan-chrome) to further enhance your learning experience by enabling flash card creation from your
web browser.
## Motivation ## ## Requirements ##
For running:
* [Anki](http://ankisrs.net/)
For building:
* [7-Zip](http://www.7-zip.org/)
* [Python 2.7](http://www.python.org/download/releases/2.7/)
* [Qt Designer](https://www.qt.io/ide/)
The software I was using for mining up to now was [Rikaichan](http://www.polarcloud.com/rikaichan/). I'm sure most
people studying the Japanese language are familiar with this browser extension and probably have it installed in
Firefox. Although pretty amazing, this tool is bound to Firefox. Firefox is obviously not a book reader: it doesn't
behave well with large text files, doesn't remember where you last stopped reading, and most importantly there was no
integration with Anki. As such, adding new vocab to my Anki deck was annoying; I wanted to be able to do this with one
mouse click. After several hours of work, Yomichan could do this and much more.
## Installation ## ## Installation ##
Yomichan can be downloaded from the its [Anki shared addon page](https://ankiweb.net/shared/info/934748696). There is an Yomichan can be downloaded from the its [Anki shared addon page](https://ankiweb.net/shared/info/934748696). There is an
automatic update checker included in the plugin that (unless you disabled it in options) will notify you when new automatic update checker included in the plugin that (unless you disabled it in options) will notify you when new
versions become available. Developers can also clone the [repository on versions become available. Developers can also clone the [repository on GitHub](https://github.com/FooSoft/yomichan); be
GitHub](https://github.com/FooSoft/yomichan-chrome); be aware that [Git LFS](https://git-lfs.github.com/) is required aware that [Git LFS](https://git-lfs.github.com/) is required for downloading the included Japanese data files.
for downloading the included Japanese data files.
## Usage ## ## Usage ##
@ -75,8 +79,8 @@ By request, I've added several keyboard shortcuts which make Yomichan even easie
AnkiConnect is a revolutionary feature which allows external applications to communicate with Anki, making it possible AnkiConnect is a revolutionary feature which allows external applications to communicate with Anki, making it possible
to query decks and create new flash cards directly. This feature must be enabled through the preference dialog prior to to query decks and create new flash cards directly. 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 use. AnkiConnect is also available as a [separate plugin](https://foosoft.net/projects/anki-connect/) for those who want to get this
in a smaller package. feature in a smaller package.
### Importing Vocabulary ### ### Importing Vocabulary ###