From 5232b945a7054691ca90dbb6493cf30bb00c5401 Mon Sep 17 00:00:00 2001 From: toasted-nutbread Date: Sun, 24 Jan 2021 22:33:59 -0500 Subject: Update Basic Usage section of the readme (#1307) * Update the Basic Usage section of the readme * Update wording on welcome page to match readme --- README.md | 29 ++++++++++++--------- ext/bg/welcome.html | 4 +-- resources/images/browser-action-popup1.png | Bin 0 -> 3529 bytes resources/images/browser-action-popup2.png | Bin 0 -> 3819 bytes resources/images/search-popup-kanji-thumb.png | Bin 0 -> 6260 bytes resources/images/search-popup-kanji.png | Bin 0 -> 22040 bytes resources/images/search-popup-terms-thumb.png | Bin 0 -> 7572 bytes resources/images/search-popup-terms.png | Bin 0 -> 21887 bytes .../images/settings-dictionaries-popup-thumb.png | Bin 0 -> 3756 bytes resources/images/settings-dictionaries-popup.png | Bin 0 -> 23668 bytes 10 files changed, 18 insertions(+), 15 deletions(-) create mode 100644 resources/images/browser-action-popup1.png create mode 100644 resources/images/browser-action-popup2.png create mode 100644 resources/images/search-popup-kanji-thumb.png create mode 100644 resources/images/search-popup-kanji.png create mode 100644 resources/images/search-popup-terms-thumb.png create mode 100644 resources/images/search-popup-terms.png create mode 100644 resources/images/settings-dictionaries-popup-thumb.png create mode 100644 resources/images/settings-dictionaries-popup.png diff --git a/README.md b/README.md index cea5649f..0c21cdf8 100644 --- a/README.md +++ b/README.md @@ -84,32 +84,35 @@ primary language is not English, you may consider also importing the English ver ## Basic Usage ## -1. Click on the ![](https://foosoft.net/projects/yomichan/img/yomichan-icon.png) icon in the browser toolbar to open the Yomichan actions dialog. +1. Click the _Yomichan_ button in the browser bar to open the quick-actions popup. - [![](https://foosoft.net/projects/yomichan/img/ui-actions-thumb.png)](https://foosoft.net/projects/yomichan/img/ui-actions.png) + -2. Click on the *spanner/cog* icon in the middle to open the options page. + * The _cog_ button will open the settings page. + * The _magnifying glass_ button will open the search page. + * The _question mark_ button will open a page with some general information about Yomichan. + * The _profile_ button will appear when multiple profiles exist, allowing the current profile to be quickly changed. -3. Import the dictionaries you wish to use for term and kanji searches. If you do not have any dictionaries installed - (or enabled), Yomichan will warn you that it is not ready for use by displaying an orange exclamation mark over its +2. Import the dictionaries you wish to use for term and kanji searches. If you do not have any dictionaries installed + or enabled, Yomichan will warn you that it is not ready for use by displaying an orange exclamation mark over its icon. This exclamation mark will disappear once you have installed and enabled at least one dictionary. - [![](https://foosoft.net/projects/yomichan/img/ui-import-thumb.png)](https://foosoft.net/projects/yomichan/img/ui-import.png) + -4. Hold down the Shift key or the middle mouse button as you move your mouse over text to display a popup - window containing term definitions. This window will only be shown if definitions were found and it can be dismissed - by clicking anywhere outside of it. +3. Webpage text can be scanned by moving the cursor while holding the scanning modifier key, which is Shift + by default. If definitions are found for the text at the cursor position, a popup window containing term definitions + will open. This window can be dismissed by clicking anywhere outside of it. - [![](https://foosoft.net/projects/yomichan/img/ui-terms-thumb.png)](https://foosoft.net/projects/yomichan/img/ui-terms.png) + -5. Click on the ![](https://foosoft.net/projects/yomichan/img/btn-play-audio.png) icon to hear the term pronounced by a native speaker. If an audio sample is +4. Click on the _speaker_ button to hear the term pronounced by a native speaker. If an audio sample is not available, you will hear a short click instead. You can configure the sources used to retrieve audio samples in the options page. -6. Click on individual kanji in the term definition results to view additional information about those characters, +5. Click on individual kanji in the term definition results to view additional information about those characters, including stroke order diagrams, readings, meanings, as well as other useful data. - [![](https://foosoft.net/projects/yomichan/img/ui-kanji-thumb.png)](https://foosoft.net/projects/yomichan/img/ui-kanji.png) + ## Custom Dictionaries ## diff --git a/ext/bg/welcome.html b/ext/bg/welcome.html index f705dfce..5ff3c818 100644 --- a/ext/bg/welcome.html +++ b/ext/bg/welcome.html @@ -36,7 +36,7 @@
- Clicking the Yomichan icon in the browser bar will open the quick-actions popup. + Clicking the Yomichan button in the browser bar will open the quick-actions popup.
@@ -79,7 +79,7 @@
- Clicking the speaker icon of an entry in the popup search results + Clicking the speaker button of an entry in the popup search results will play an audio clip of a term's pronunciation using an online dictionary, if available.
diff --git a/resources/images/browser-action-popup1.png b/resources/images/browser-action-popup1.png new file mode 100644 index 00000000..1c241ac7 Binary files /dev/null and b/resources/images/browser-action-popup1.png differ diff --git a/resources/images/browser-action-popup2.png b/resources/images/browser-action-popup2.png new file mode 100644 index 00000000..76c15b12 Binary files /dev/null and b/resources/images/browser-action-popup2.png differ diff --git a/resources/images/search-popup-kanji-thumb.png b/resources/images/search-popup-kanji-thumb.png new file mode 100644 index 00000000..8a80475a Binary files /dev/null and b/resources/images/search-popup-kanji-thumb.png differ diff --git a/resources/images/search-popup-kanji.png b/resources/images/search-popup-kanji.png new file mode 100644 index 00000000..2fe890b9 Binary files /dev/null and b/resources/images/search-popup-kanji.png differ diff --git a/resources/images/search-popup-terms-thumb.png b/resources/images/search-popup-terms-thumb.png new file mode 100644 index 00000000..c3a80817 Binary files /dev/null and b/resources/images/search-popup-terms-thumb.png differ diff --git a/resources/images/search-popup-terms.png b/resources/images/search-popup-terms.png new file mode 100644 index 00000000..3af29a61 Binary files /dev/null and b/resources/images/search-popup-terms.png differ diff --git a/resources/images/settings-dictionaries-popup-thumb.png b/resources/images/settings-dictionaries-popup-thumb.png new file mode 100644 index 00000000..5f85904b Binary files /dev/null and b/resources/images/settings-dictionaries-popup-thumb.png differ diff --git a/resources/images/settings-dictionaries-popup.png b/resources/images/settings-dictionaries-popup.png new file mode 100644 index 00000000..e37d8a22 Binary files /dev/null and b/resources/images/settings-dictionaries-popup.png differ -- cgit v1.2.3