diff --git a/README.html b/README.html
index 337c3ef..ce9355d 100644
--- a/README.html
+++ b/README.html
@@ -1,13 +1,25 @@
+
-Chinese Support Redux is a rewrite and port of the original Chinese Support add-on to Anki 2.1. It offers a number of features that streamline the process of creating flashcards for learning Chinese. The current focus of development effort is on improving the stability of the add-on and the accuracy of its output. Once the core functionality is sufficiently robust and reliable, additional features will be considered. While many of the changes will be structural in nature, I would encourage users to update the add-on whenever the version number increases and notify me of any problems. Your feedback is important.
+Chinese Support Redux is an Anki 2.1-compatible rewrite of the original Chinese Support add-on. It offers a number of features that streamline the process of creating flashcards for learning Chinese. The current focus of development effort is on improving the stability of the add-on and the accuracy of its output. Once the core functionality is sufficiently robust and reliable, additional features will be considered.
-Important Note: If you find that a field is not filling at all, please check config.json for the complete list of valid field names.
+Please note that the add-on is still in beta and is sometimes shipped in an unstable state. Please upgrade with each new release and report any issues on GitHub. The automated test suite is a work-in-progress, so I still rely heavily on user reports to supplement my own manual testing.
+
+Important Notes
+
+- If you find that a field is not filling at all, please check config.json for the complete list of valid field names. For those migrating from an older version of the add-on, you will need to rename any definition fields to
English, German or French, depending on what you want. - If tone colours are not showing, ensure that the styling section of the template contains the following CSS:
+
+.tone1 {color: red;}
+.tone2 {color: orange;}
+.tone3 {color: green;}
+.tone4 {color: blue;}
+.tone5 {color: gray;}
+
Features
-- Automatic field filling
- Translation (from built-in dictionary; supports English, German and French)
- Romanisation (supports Pīnyīn (拼音) and Cantonese Jyutping (粵拼))
- Mandarin Audio (fetched from Google or Baidu)
- Traditional (繁體字) and simplified (簡體字) characters
- Bopomofo (ㄅㄆㄇㄈ), also known as Zhuyin (注音)
- Rubies (small-print transcription placed above characters)
- Frequency (from “very basic” to “obscure”). Based on anki-chinese-word-frequency
- Tone colours (applied to characters, romanisation and Bopomofo)
- Built-in note types (Basic and Advanced)
+- Automatic field filling
- Translation (from built-in dictionary; supports English, German and French)
- Romanisation (supports Pīnyīn (拼音) and Cantonese Jyutping (粵拼))
- Mandarin Audio (fetched from Google or Baidu)
- Traditional (繁體字) and simplified (簡體字) characters
- Bopomofo (ㄅㄆㄇㄈ), also known as Zhuyin (注音)
- Rubies (small-print transcription placed above characters)
- Frequency (from “very basic” to “obscure”) - based on anki-chinese-word-frequency
- Usage Sentence Examples - Chinese/English sentence pairs from Tatoeba
- Tone colours (applied to characters, romanisation and Bopomofo)
- Built-in note types (Basic and Advanced)
Status
The vast majority of features have been successfully ported, and the add-on is in a usable state, albeit with some definite rough edges.
@@ -20,7 +32,7 @@
Usage
-The core feature of the add-on is the automatic field filling. To take advantage of this, you need to have an Anki note type with the appropriate fields (e.g., Hanzi, Meaning, Reading, Sound). See config.json for a list of valid field names.
+The core feature of the add-on is the automatic field filling. To take advantage of this, you need to have an Anki note type with the appropriate fields (e.g., Hanzi, English, Pinyin, Sound). See config.json for a list of valid field names.
If you don't already have such a note type, the easiest approach is to use one of the built-in models. Two types are installed automatically: Basic and Advanced. The only important difference is that the Advanced model shows more information.
@@ -39,7 +51,9 @@
I understand the documentation is sparse. Anyone who wishes to add content to the wiki is more than welcome to.
-Testing
+Development
+
+Testing
For those who wish to run the tests locally, this is fairly straightforward.
@@ -64,3 +78,12 @@
pip install -r requirements.txt
make test
+
+Debugging with PyCharm
+
+(a) Without Anki Source
- Copy the repo root to the Anki add-ons folder. As of version 2.1, this is
%AppData%\Anki2\addons21 - Create a Python 3.8 virtual environment in PyCharm for the add-on folder (make sure you are running 64-bit Python). This can be done with:
pythonimport platformplatform.architecture() - Run the following in the PyCharm console (these could be added to
requirements.txt instead):pythonimport subprocesssubprocess.check_call(["pip3", "install", "mypy", "anki", "ankirspy", "aqt", "pyqt5", pyqtwebengine"]) - Install the
requirements.txt for the project venv - Create a file for debugging in PyCharm as:
pythonimport aqtaqt.run() - Start debugging. The first Anki run will pick up the
tests folder as a plugin and error out. This is expected. - Go to the Tools → Add-ons menu and disable
tests - Enjoy coding!
+(b) With Anki Source
- Download and extract Anki source code somewhere on the hard drive.
- Create a folder such as
anki-addon-dev on your hard drive and open it on PyCharm as a project. Then, open Anki source code folder as another project within the current project window by choosing Attach. - Under
Preferences → Project → Project Dependencies → anki-addon-dev, check the box to approve the add-on depends on Anki source code. - Under the run configurations beside run and debug buttons, edit the configuration as follows:
- Script Path:
[PATH_TO_ANKI_SOURCE_FOLDER]/anki-2.1.13/runanki - Parameters:
-b [PATH_TO_ANKI_ADDON_PROJECT]/anki-addon-dev - Create your project files and do the development on this path:
anki-addon-dev/addons21/[YOUR_PROJECT_FOLDER] - Happy debugging while developing
+Additional Guidance
+
+
+
diff --git a/README.md b/README.md
index 0375000..7973918 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
-**_2021 Project Status: Active development will resume on Saturday the 27th of February._**
-
# Chinese Support Redux
[](https://app.codacy.com/app/luoliyan/chinese-support-redux?utm_source=github.com&utm_medium=referral&utm_content=luoliyan/chinese-support-redux&utm_campaign=Badge_Grade_Dashboard)
[](https://travis-ci.org/luoliyan/chinese-support-redux) [](https://coveralls.io/github/luoliyan/chinese-support-redux?branch=master)
+[](https://ko-fi.com/X8X01RVSD)
+
Chinese Support Redux is an Anki 2.1-compatible rewrite of the [original](https://github.com/ttempe/chinese-support-addon) Chinese Support add-on. It offers a number of features that streamline the process of creating flashcards for learning Chinese. The current focus of development effort is on improving the stability of the add-on and the accuracy of its output. Once the core functionality is sufficiently robust and reliable, additional features will be considered.
Please note that the add-on is still in beta and is sometimes shipped in an unstable state. Please upgrade with each new release and report any issues on GitHub. The automated test suite is a work-in-progress, so I still rely heavily on user reports to supplement my own manual testing.
@@ -73,7 +73,9 @@ If you encounter any issues, the best way to have these addressed is to [raise t
I understand the documentation is sparse. Anyone who wishes to add content to [the wiki](https://github.com/luoliyan/chinese-support-redux/wiki) is more than welcome to.
-## Testing
+## Development
+
+### Testing
For those who wish to run the tests locally, this is fairly straightforward.
@@ -99,46 +101,46 @@ pip install -r requirements.txt
make test
```
+### Debugging with PyCharm
-## Debug with PyCharm
-### Without Anki Source
+#### (a) Without Anki Source
-1. Copy the repo root to the anki plugins folder. As of 2.1 this is : `C:\Users\\AppData\Roaming\Anki2\addons21`
-2. Create py 3.8 venv in pycharm for addon folder. Make sure you are running 64 bit python. This can be done with
+1. Copy the repo root to the Anki add-ons folder. As of version 2.1, this is `%AppData%\Anki2\addons21`
+2. Create a Python 3.8 virtual environment in PyCharm for the add-on folder (make sure you are running 64-bit Python). This can be done with:
```python
import platform
platform.architecture()
```
-3. Run the following in the pycharm python console (these could be added to requirements.txt instead):
-
+3. Run the following in the PyCharm console (these could be added to `requirements.txt` instead):
``` python
import subprocess
subprocess.check_call(["pip3", "install", "mypy", "anki", "ankirspy", "aqt", "pyqt5", pyqtwebengine"])
```
-4. Install the requirements.txt for the project venv
-
-5. Create a file for debugging in pycharm as:
+4. Install the `requirements.txt` for the project venv
+5. Create a file for debugging in PyCharm as:
``` python
import aqt
-
aqt.run()
```
-6. Start debugging. The first anki run will pick up the 'tests' folder as a plugin and error out. This is expected.
-7. Go to the Tools->Add-ons menu and disable 'tests'
+6. Start debugging. The first Anki run will pick up the `tests` folder as a plugin and error out. This is expected.
+7. Go to the Tools → Add-ons menu and disable `tests`
8. Enjoy coding!
-### With Anki Source
+#### (b) With Anki Source
+
1. Download and extract Anki source code somewhere on the hard drive.
2. Create a folder such as `anki-addon-dev` on your hard drive and open it on PyCharm as a project. Then, open Anki source code folder as another project within the current project window by choosing Attach.
-3. On `Preferences -> Project -> Project Dependencies -> anki-addon-dev`: Check the box to approve the add-on depends on Anki source code.
-4. Under the run configurations beside run and debug buttons, edit configurations as follows:
-Script Path: `[YOUR_PATH_TO_ANKI_SOURCE_FOLDER]/anki-2.1.13/runanki`
-Parameters: `-b [YOUR_PATH_TO_ANKI_ADDON_PROJECT]/anki-addon-dev`
+3. Under `Preferences → Project → Project Dependencies → anki-addon-dev`, check the box to approve the add-on depends on Anki source code.
+4. Under the run configurations beside run and debug buttons, edit the configuration as follows:
+- Script Path: `[PATH_TO_ANKI_SOURCE_FOLDER]/anki-2.1.13/runanki`
+- Parameters: `-b [PATH_TO_ANKI_ADDON_PROJECT]/anki-addon-dev`
5. Create your project files and do the development on this path:
`anki-addon-dev/addons21/[YOUR_PROJECT_FOLDER]`
6. Happy debugging while developing
-### Additional Debugging Guidance
-- https://addon-docs.ankiweb.net/#/getting-started
-- https://github.com/ankitects/anki/blob/stable/README.development
-- https://chrisk91.me/2018/02/13/Setting-up-VSCode-for-Anki-addon-development.html
\ No newline at end of file
+### Additional Guidance
+
+- [Writing Anki Add-ons - Getting Started](https://addon-docs.ankiweb.net/#/getting-started)
+- [Anki development README](https://github.com/ankitects/anki/blob/main/docs/development.md)
+- [Setting up VSCode for Anki add on development](https://chrisk91.me/2018/02/13/Setting-up-VSCode-for-Anki-addon-development.html)
+
diff --git a/tests/test_behavior.py b/tests/test_behavior.py
index 6945d4b..9526607 100644
--- a/tests/test_behavior.py
+++ b/tests/test_behavior.py
@@ -300,7 +300,7 @@ def model(self):
'Ruby (Bopomofo)': '床单',
'Ruby (Jyutping)': '',
'Silhouette': '_ _',
- 'Sound (Mandarin)': '[sound:床单_google_zh-cn.mp3]',
+ 'Sound (Mandarin)': '[sound:床单_google_zh-CN.mp3]',
'Sound (Cantonese)': '',
}
fields = expected.keys()