Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README, Settings to include new MeCab installer repo #326

Merged
merged 10 commits into from
Nov 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
>
> Since the owner requested forks be uniquely named, we have chosen a new name: _yomitan_. (_-tan_ is an honorific used for anthropomorphic moe characters.) While we've renamed the codebase and made judicious use of find-and-replace, it is entirely the hard work of foosoft and numerous other open source contributors from 2016-2023 and we do not claim any credit.
>
> Since this is a distributed effort, we highly welcome new contributors! Feel free to browse the issue tracker, and you can find us on [TheMoeWay Discord](https://discord.gg/UGNPMDE7zC) at [#yomitan-development](https://discord.com/channels/617136488840429598/1081538711742844980)
> Since this is a distributed effort, we highly welcome new contributors! Feel free to browse the issue tracker, and you can find us on [TheMoeWay Discord](https://discord.gg/UGNPMDE7zC) at [#yomitan-development](https://discord.com/channels/617136488840429598/1081538711742844980).

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. This extension is similar to
Expand Down Expand Up @@ -50,6 +50,8 @@ Yomitan provides advanced features not available in other browser-based dictiona
- [Flashcard Configuration](#flashcard-configuration)
- [Flashcard Creation](#flashcard-creation)
- [Keyboard Shortcuts](#keyboard-shortcuts)
- [Advanced Options](#advanced-options)
- [Parse sentences using MeCab](#parse-sentences-using-mecab)
- [Frequently Asked Questions](#frequently-asked-questions)
- [Licenses](#licenses)
- [Third-Party Libraries](#third-party-libraries)
Expand Down Expand Up @@ -319,6 +321,17 @@ The following shortcuts are available on search results:
| <kbd>Alt</kbd> + <kbd>p</kbd> | Play audio for current term. |
| <kbd>Alt</kbd> + <kbd>k</kbd> | Add current kanji to Anki. |

## Advanced Options

Click the `Advanced` toggle switch in the bottom left corner of the Settings page to enable advanced options.

### Parse sentences using MeCab

[MeCab](https://taku910.github.io/mecab/) is a third-party program which uses its own dictionaries and parsing algorithm to decompose sentences into individual words. MeCab may provide more accurate parsing results than Yomitan's internal parser.

In order for Yomitan to use it, both MeCab and a native messaging component must be installed.
A setup guide can be found [here](https://github.com/themoeway/yomitan-mecab-installer/blob/master/README.md).

## Frequently Asked Questions

**I'm having problems importing dictionaries in Firefox, what do I do?**
Expand Down
2 changes: 1 addition & 1 deletion ext/settings.html
Original file line number Diff line number Diff line change
Expand Up @@ -1395,7 +1395,7 @@ <h1>Yomitan Settings</h1>
</p>
<p>
In order for Yomitan to use it, both MeCab and a native messaging component must be installed.
A setup guide can be found <a href="https://github.com/siikamiika/yomichan-mecab-installer/blob/master/README.md" target="_blank" rel="noopener noreferrer">here</a>.
A setup guide can be found <a href="https://github.com/themoeway/yomitan-mecab-installer/blob/master/README.md" target="_blank" rel="noopener noreferrer">here</a>.
</p>
<div class="margin-above flex-row-nowrap">
<button type="button" id="test-mecab-button">Test</button>
Expand Down
Loading