Updating README.md

This commit is contained in:
Alex Yatskov 2016-07-10 13:39:47 -07:00
parent 183c4115d5
commit 1476ed4b71

View File

@ -5,28 +5,29 @@ texts which would be otherwise too difficult tackle. This extension was inspired
[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](https://foosoft.net/projects/yomichan) plugin that I developed for [Anki](http://ankisrs.net/) when I
was starting to learn Japanese back in 2011.
natural evolution of the [Yomichan](https://foosoft.net/projects/yomichan) plugin that I developed for Anki when I was starting to learn
Japanese back in 2011.
<iframe width="800" height="500" src="https://www.youtube.com/embed/90_A1VpTnMk" frameborder="0" allowfullscreen></iframe>
## Build Requirements ##
## Requirements ##
For building:
* [7-Zip](http://www.7-zip.org/)
* [Git LFS](https://git-lfs.github.com/)
* [Handlebars](http://handlebarsjs.com/)
* [Node.js](https://nodejs.org/)
* [Python 3](https://www.python.org/downloads/releases/3.0)
For AnkiConnect:
* [Anki](http://ankisrs.net/)
## Installation ##
The most straightforward 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), provided that you have have [Git
LFS](https://git-lfs.github.com/) installed (it is required to download the included dictionary files).
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
[Yomichan](https://foosoft.net/projects/yomichan) installed, AnkiConnect can be used after it is enabled in the plugin preferences.
The simplest way to install this extension is to download it from the [Chrome Web
Store](https://chrome.google.com/webstore/detail/yomichan/ogmnaimimemjmbakcfefmnahgdfhfami).
## Usage ##