From a7231596e1fcd79cc2ae279c2190c921fc079778 Mon Sep 17 00:00:00 2001 From: Pierce Morris Date: Sun, 7 Jan 2024 15:05:43 +0000 Subject: [PATCH] descriptive links, typos, anki emphasis --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2c50917491..3f5baacd99 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Yomitan ・[![Chrome Release (Stable)]()](https://chrome.google.com/webstore/detail/yomitan/likgccmbimhjbgkjambclfkhldnlhbnn) [![Firefox Release (Stable)]()](https://addons.mozilla.org/en-US/firefox/addon/yomitan/) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/themoeway/yomitan/badge)](https://securityscorecards.dev/viewer/?uri=github.com/themoeway/yomitan) [![Discord Server](https://dcbadge.vercel.app/api/server/UGNPMDE7zC?style=flat)](https://discord.gg/UGNPMDE7zC) +# Yomitan ・[![Chrome Release]()](https://chrome.google.com/webstore/detail/yomitan/likgccmbimhjbgkjambclfkhldnlhbnn) [![Firefox Release]()](https://addons.mozilla.org/en-US/firefox/addon/yomitan/) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/themoeway/yomitan/badge)](https://securityscorecards.dev/viewer/?uri=github.com/themoeway/yomitan) [![Discord](https://dcbadge.vercel.app/api/server/UGNPMDE7zC?style=flat)](https://discord.gg/UGNPMDE7zC) :wave: **This project is a community fork of Yomichan** (which was [sunset](https://foosoft.net/posts/sunsetting-the-yomichan-project/) by its owner on Feb 26 2023). We have made a number of foundational changes to ensure **the project stays alive, works on latest browser versions, and is easy to contribute to**: @@ -18,7 +18,7 @@ Since the owner requested forks be uniquely named, we have chosen a new name, _y ## What's Yomitan? Yomitan turns your web browser into a tool for building Japanese language literacy by helping you to decipher texts -which would be otherwise too difficult tackle. +which would be otherwise too difficult tackle. This extension is similar to [10ten Japanese Reader (formerly Rikaichamp)](https://addons.mozilla.org/en-US/firefox/addon/10ten-ja-reader/) for Firefox and [Rikaikun](https://chrome.google.com/webstore/detail/rikaikun/jipdnfibhldikgcjhfnomkfpcebammhp?hl=en) for Chrome, but it stands apart in its goal of being an all-encompassing learning tool as opposed to a mere browser-based dictionary. Yomitan provides advanced features not available in other browser-based dictionaries: @@ -35,12 +35,12 @@ Yomitan provides advanced features not available in other browser-based dictiona [![Dictionary options](img/ss-dictionaries-thumb.png)](img/ss-dictionaries.png) [![Anki options](img/ss-anki-thumb.png)](img/ss-anki.png) -## Documentation +## Helpful information -- [Migrating from Yomichan](./docs/yomichan-migration.md#migrating-from-yomichan) -- [Adding dictionaries](./docs/dictionaries.md#dictionaries) -- [Anki integration and flashcards](./docs/anki-integration.md#anki-integration) -- [Advanced options](./docs/advanced-options.md#advanced-options) +- [Migrating from Yomichan (legacy)](./docs/yomichan-migration.md#migrating-from-yomichan) +- [Importing standardised and custom dictionaries](./docs/dictionaries.md#dictionaries) +- [Anki integration and flashcards creation](./docs/anki-integration.md#anki-integration) +- [Advanced options, including MeCab](./docs/advanced-options.md#advanced-options) - [Frequently asked questions](./docs/faq.md#frequently-asked-questions) - [Keyboard shortcuts](./docs/keyboard-shortcuts.md) @@ -71,7 +71,7 @@ updates automatically. - The question mark symbol _question mark_ button will open the Information page. - The profile icon _profile_ button will appear when multiple profiles exist, allowing the current profile to be quickly changed. -2. Import the dictionaries you wish to use for term and kanji searches, head over to the [the dictionary docs](./docs/dictionaries.md) to get set up!. If you do not have any dictionaries installed or enabled, Yomitan 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. +2. Import the dictionaries you wish to use for term and kanji searches, head over to the [the dictionary docs](./docs/dictionaries.md) to get set up! If you do not have any dictionaries installed or enabled, Yomitan 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. custom dictionaries list @@ -85,6 +85,8 @@ updates automatically. popup with kanji details +To further enhance your Yomitan experience, it's worth [integrating with Anki](./docs/anki-integration.md), a spaced-repetition flashcard program to help solidify the words you encounter + ## Contributing Since this is a distributed effort, we **highly welcome new contributors**! Feel free to browse the [issue tracker](https://github.com/themoeway/yomitan/issues), and read our [contributing guidelines](./CONTRIBUTING.md). You can also find us on [TheMoeWay Discord](https://discord.gg/UGNPMDE7zC) at [#yomitan-development](https://discord.com/channels/617136488840429598/1081538711742844980).