alex/yomichan
1
Fork 0
Code Releases Activity

Updating README.md

Browse Source
This commit is contained in:
Alex Yatskov 2017-01-11 20:41:44 -08:00
parent dcd17bc654
commit ed1b1d9181
1 changed files with 9 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -48,12 +48,8 @@ works, please see the [Yomichan Import](https://foosoft.net/projects/yomichan-im
## Anki Integration ## ## Anki Integration ##
Yomichan features automatic flashcard creation for [Anki](http://ankisrs.net/), a free application designed to help you Yomichan features automatic flashcard creation for [Anki](http://ankisrs.net/), a free application designed to help you
retain knowledge. While the [AnkiConnect](https://foosoft.net/projects/anki-connect/) plugin offers the best experience, retain knowledge. This functionality requires prior installation of the
it is also possible to create flashcards through [AnkiWeb](https://ankiweb.net/), provided you already have an account. [AnkiConnect](https://foosoft.net/projects/anki-connect/) plugin. The installation process can be done in three steps:
### Using AnkiConnect ###
Installing the AnkiConnect plugin for Anki is the preferred way of enabling automatic flashcard creation in Yomichan.
1. Open the *Install Add-on* dialog by selecting *Tools* > *Add-ons* > *Browse & Install* in Anki. 1. Open the *Install Add-on* dialog by selecting *Tools* > *Add-ons* > *Browse & Install* in Anki.
2. Input *2055492159* into the text box labeled *Code* and press the *OK* button to proceed. 2. Input *2055492159* into the text box labeled *Code* and press the *OK* button to proceed.
@ -61,19 +57,6 @@ Installing the AnkiConnect plugin for Anki is the preferred way of enabling auto
When using AnkiConnect, Anki must be kept running in the background for automatic flashcard creation to function. When using AnkiConnect, Anki must be kept running in the background for automatic flashcard creation to function.
### Using AnkiWeb ###
Yomichan is able to create flashcards directly on AnkiWeb, assuming you have [registered an
account](https://ankiweb.net/account/register). While this method can be convenient as it does not require Anki to be
running to running in the background, some features are not supported due to technical limitations:
* Preventing the creation of duplicate flashcards.
* Embedding audio in flashcards via the `{audio}` marker.
Your AnkiWeb login information must specified on the options page to make use of automatic flashcard creation. Note
that AnkiWeb will temporarily block your IP address if there are too many login attempts; if this happens, just try
again after waiting for about an hour.
### Flashcard Configuration ### ### Flashcard Configuration ###
Before flashcards can be automatically created through Yomichan, Anki must be configured as follows: Before flashcards can be automatically created through Yomichan, Anki must be configured as follows:
@ -117,6 +100,13 @@ Before flashcards can be automatically created through Yomichan, Anki must be co
## Frequently Asked Questions ## ## Frequently Asked Questions ##
* **What happened to AnkiWeb integration? Why was it removed?**
The author of Anki wants to maintain tight control of AnkiWeb by restricting automated web requests, while at the
same time not providing an API for adding or removing flash cards. As circumventing these restrictions led to
account restrictions placed on users of this extension, I was forced to remove this feature. Note that it is still
possible to automatically generate flashcards with the AnkiConnect plugin.
* **Is it possible to use Yomichan with files saved locally on my computer?** * **Is it possible to use Yomichan with files saved locally on my computer?**
It in order to be able use Yomichan with local files, you must first tick the *Allow access to file URLs* checkbox It in order to be able use Yomichan with local files, you must first tick the *Allow access to file URLs* checkbox