forked from migaku-official/Migaku-Japanese-Addon
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
eec2ac4
commit 20a554f
Showing
1 changed file
with
47 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,55 +1,51 @@ | ||
| ### Fork of the Migaku Japanese Addon to support Anki 2.1.50+ (Qt6). Work is still in progress and current version is still unstable. | ||
|
|
||
| Broken functionality: | ||
| # Migaku Japanese Addon Updated | ||
| This project is an unofficial fork of the [Migaku Japanese Addon](https://github.com/migaku-official/Migaku-Japanese-Addon) aiming to be compatible with Anki 2.1.50+ (Qt6). | ||
| The plan for this project is to regularly update the addon to be compatible with the latest Anki version. | ||
| I personally don't want to make any big improvements or implement new features, though feel free to create a PR/issue if you want to :). | ||
|
|
||
| ## Changes | ||
| Changes from original project: | ||
| - Updated code to be compatible with Anki 2.1.50+ (QT6 version). | ||
| - Removed the Migaku message popup at startup. | ||
| - Added better descriptions to the generation buttons in the edit-card view. | ||
| - In the card browser under 'Edit', changed the name of the generation action to include `(Migaku Japanese)` so it's clear this action is from this addon. | ||
| - Changed the About page to make it clear this is a fork. Also include the new version at the title of the Migaku window. | ||
|
|
||
| Currently, the following functionality is broken (not sure if these were already broken in the original): | ||
| - (linux) Generation of Pitch Graphs. | ||
| - (linux) Generation of audio to Clipboard | ||
| <h2 align="center">Migaku Japanese Addon</h2> | ||
|
|
||
| <p align="center"> | ||
| <a title="Rate on AnkiWeb" href="https://ankiweb.net/shared/info/278530045"><img src="https://glutanimate.com/logos/ankiweb-rate.svg"></a> | ||
| <a title="License: GNU AGPLv3" href="https://github.com/migaku-official/Migaku-Japanese-Addon/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-GNU AGPLv3-green.svg"></a> | ||
| <br> | ||
| <a title="Support us on Patreon" href="https://www.patreon.com/Migaku"><img src="https://img.shields.io/badge/patreon-support-orange.svg"></a> | ||
| <br> | ||
| <a title="Subscribe to Immerse with Migaku" href="https://www.youtube.com/c/ImmerseWithYoga"><img src="https://img.shields.io/badge/YouTube-Immerse%20with%20Yoga-red"></a> | ||
| <br> | ||
| <a title="Follow us on Twitter" href="https://twitter.com/Migaku_Yoga"><img src="https://img.shields.io/badge/Twitter-Immerse%20with%20Yoga-blue"></a> | ||
| </p> | ||
|
|
||
| >Add readings and pitch accent information to Japanese words, allows playing audio when clicking a word, export pitch accent graphs, convert to katakana, or historical kanji and kana and much more! | ||
| ### Table of Contents | ||
|
|
||
| - [Installation](#installation) | ||
| - [Documentation](#documentation) | ||
| - [Contributing](#contributing) | ||
| - [License and Credits](#license-and-credits) | ||
|
|
||
| ### Installation | ||
|
|
||
| 1. Install the version of Anki that is listed under the "Migaku Development Cycles" section of the AnkiWeb add-on [page](https://ankiweb.net/shared/info/278530045). | ||
| 2. Download the latest version of the addon from [AnkiWeb](https://ankiweb.net/shared/info/278530045) | ||
|
|
||
| ### Documentation | ||
|
|
||
| Documentation coming soon | ||
|
|
||
| ### Contributing | ||
|
|
||
| Contributions are welcome! Please review the [contribution guidelines](./.github/CONTRIBUTING.md) on how to: | ||
|
|
||
| - Report issues | ||
| - File pull requests | ||
| - Support the project as a non-developer | ||
|
|
||
| ### License and Credits | ||
|
|
||
| *Migaku Japanese* is | ||
|
|
||
| - (linux) Generation of audio to Clipboard. | ||
|
|
||
| ## Installation | ||
| ### Uninstalling the previous version and installing the new Anki version | ||
| Note: all settings, except for the Overwrite Rules, will be removed during process. Make sure you have noted down your current settings or made screenshots before | ||
| proceeding. | ||
| 1. Uninstall the previous Migaku Japanese Addon: go to `Tools` > `Add-ons`, select Migaku Japanese Addon and click `Delete`. | ||
| 1.1. You can also open the addons folder in this screen which we will use in step 5, click on `View Files`. | ||
| 2. Close Anki | ||
| 3. Download and install Anki 2.1.54 (Qt6) or newer from [their website](https://apps.ankiweb.net/). | ||
|
|
||
| ### Installation of this addon | ||
| 4. Download the Zip file and move the `Migaku-Japanese-Addon-Updated` folder into the `addons21` folder (you may have opened this folder in step 1.1). | ||
| 5. Start Anki. | ||
| 6. Go to `Migaku` > `Japanese Settings` to configure your settings. | ||
|
|
||
| ## Contributing and bug reports | ||
| Contributions are welcome! Feel free to: | ||
| - Create an issue if you found a bug (please make sure you are using Anki version 2.1.50 or later in the QT6 edition) | ||
| - Create pull requests | ||
| - Participate in the Discussions | ||
|
|
||
| ## Credits | ||
| I would like to sincerely thank Migaku for creating the original addon and releasing the code under GPL-V3. | ||
| Please check out their [website](https://www.migaku.io/), [patreon](https://www.patreon.com/Migaku) and [YouTube channel](https://www.youtube.com/c/ImmersewithMigaku). | ||
|
|
||
| ## Licence | ||
| *Migaku Japanese Addon Updated* is | ||
|
|
||
| *Copyright © 2022 Mike Moolenaar | ||
| *Copyright © 2020 Migaku ltd. | ||
|
|
||
| Migaku Japanese is free and open-source software. The add-on code that runs within Anki is released under the GNU AGPLv3 license, extended by a number of additional terms. For more information please see the [LICENSE](https://github.com/migaku-official/Migaku-Japanese-Addon/blob/master/LICENSE) file that accompanied this program. | ||
|
|
||
| This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY. | ||
| Migaku Japanese is free and open-source software. The add-on code that runs within Anki is released under the GNU AGPLv3 license, extended by a number of additional terms. | ||
| Just like the original project, this fork is licenced under GPL-3.0. Please see the [LICENSE](https://github.com/MikeMoolenaar/Migaku-Japanese-Addon/blob/master/LICENSE) file that is accompanied by this program. | ||
|
|
||
| ---- | ||
| This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY. |