1

Compare commits

...

10 Commits

Author SHA1 Message Date
dccd2a40ee Update README 2022-07-14 14:25:29 -07:00
35d518d6b6 Update README 2021-12-15 18:06:08 -08:00
23dcd25be3 Add site metadata 2021-12-14 20:07:04 -08:00
e317296fb7 Update README 2021-06-08 22:45:26 -07:00
b08f8728e8 Updating README.md 2019-04-28 16:02:49 -07:00
834027a0f6 Updating README.md 2019-04-28 12:34:57 -07:00
752571b90f re-add accidentally deleted files 2019-04-28 12:05:10 -07:00
e08ec49968 Revert "Revert "Updating README.md""
This reverts commit cec8eaa2ac.
2019-04-28 11:55:39 -07:00
cec8eaa2ac Revert "Updating README.md"
This reverts commit d9e53562a4.
2019-04-28 11:55:26 -07:00
d151e91b04 update license file 2019-04-28 11:54:49 -07:00
8 changed files with 64 additions and 60 deletions

14
LICENSE Normal file
View File

@ -0,0 +1,14 @@
Copyright 2011-2019 Alex Yatskov
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

View File

@ -1,67 +1,43 @@
# Yomichan Anki #
# Yomichan for Anki
Yomichan is an Anki plugin built to help students of Japanese learn the language by reading native media on their
Yomichan for Anki is 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
focus on enjoying your reading.
*Note: This project is no longer maintained and has been superseded by the [Yomichan](https://foosoft.net/projects/yomichan/) browser extension*.
*Note: This project is no longer maintained and has been superseded by the
[Yomichan](https://foosoft.net/projects/yomichan/) browser extension.*
## Requirements ##
## Installation
For running:
Yomichan for Anki can be downloaded from the [Anki shared addon page](https://ankiweb.net/shared/info/934748696). This
plugin will automatically notify you when updates are available.
* [Anki](http://ankisrs.net/) (versions 2.0.x)
For building:
* [7-Zip](http://www.7-zip.org/)
* [Git LFS](https://git-lfs.github.com/)
* [Python 2.7](http://www.python.org/download/releases/2.7/)
* [Qt Designer](https://www.qt.io/ide/)
## Installation ##
Yomichan can be downloaded from the [Anki shared addon page](https://ankiweb.net/shared/info/934748696). This plugin
will automatically notify you when updates are available.
## Usage ##
## Usage
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.
[![Card layout dialog](https://foosoft.net/projects/yomichan-anki/img/layout-thumb.png)](https://foosoft.net/projects/yomichan-anki/img/layout.png)
2. Open your vocab deck and note the fields that are used in your deck: \
![](img/layout.png)
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
different because the screenshot shows my personal settings.
[![Reader dialog](https://foosoft.net/projects/yomichan-anki/img/reader-thumb.png)](https://foosoft.net/projects/yomichan-anki/img/reader.png)
4. Open the text file you want and you will see its contents in the Yomichan. \
![](img/reader.png)
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).
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:
[![Preferences dialog](https://foosoft.net/projects/yomichan-anki/img/preferences-thumb.png)](https://foosoft.net/projects/yomichan-anki/img/preferences.png)
6. To set up your Anki deck for Yomichan select Preferences from the Edit menu: \
![](img/preferences.png)
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
*AnkiConnect* tick the checkbox labeled *Enable AnkiConnect* as shown above.
8. When you look up definitions you will have the option to create Anki cards for them with one click. You will see the
icons for performing these actions next to each item. *Icons for actions which update your decks won't show up if
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.
[![Icons](https://foosoft.net/projects/yomichan-anki/img/icons-thumb.png)](https://foosoft.net/projects/yomichan-anki/img/icons.png)
existing cards in the deck or that Yomichan hasn't been properly set up for your deck model. \
![](img/icons.png) \
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 as it appears in the dictionary including Kanji (e.g. 勉強家).
* Copy the expression, reading and definition for the term to the clipboard.
### Keyboard Shortcuts ###
### Keyboard Shortcuts
Yomichan features several keyboard shortcuts for ease of use:
@ -74,25 +50,10 @@ Yomichan features several keyboard shortcuts for ease of use:
| <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 |
### Importing Vocabulary ###
### Importing Vocabulary
Yomichan is capable of importing vocabulary lists from plain text files and the vocabulary deck database the Amazon
Kindle automatically generates when you look up words in the built-in dictionary (this file can be found as
`/system/vocabulary/vocab.db`). Note that importing does not create flash cards automatically, but rather outputs the
contents of the file to the Vocabulary and Kanji panes so that you can add facts the same way as when reading within
Yomichan.
## License ##
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

32
dl/updates.json Normal file
View File

@ -0,0 +1,32 @@
[
{
"version": "0.22b",
"features": [
"Fix definitions for certain search strings not being found",
"Popular terms are now displayed in bold",
"Improvements to the AnkiConnect interface"
]
},
{
"version": "0.21b",
"features": [
"Fixing crash that would happen when a Kanji character doesn't have both on-yomi and kun-yomi defined"
]
},
{
"version": "0.20b",
"features": [
"Support for Chrome integration via AnkiConnect; see foosoft.net/projects/yomichan",
"Fixing deinflection problems and various crashes; other tweaks and improvements",
"Better presentation, enhanced dictionary format"
]
},
{
"version": "0.17b",
"features": [
"New interface to check for updates",
"New option to save text contents between sessions"
]
}
]

BIN
img/icons.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

BIN
img/layout.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

BIN
img/preferences.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

BIN
img/reader.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 386 KiB

View File

@ -1,3 +0,0 @@
version https://git-lfs.github.com/spec/v1
oid sha256:c7716fdf1e98bc42f89e2cb2e8a7511bd050b1b781fe185d8a84b3612fa192f2
size 21696512