Yakudatsu/README.md
2024-12-26 08:49:44 +00:00

40 lines
1.4 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Yakudatsu (cli)
A simple cli tool to look up Japanese words using jisho.org's API.
Additionally, searching for kanji by radicals and browsing tatoeba's database of example sentences is also available.
### Jisho dictionary
<img src=".img/dab0ab082751a1b17271309c2ffc3c16d53c8498513619e50235e8157bab01fa.png">
### Searching by radicals
<img src=".img/9cee906502836f1e4d66c780201517d51d2e6cf558be32d2644fbe408b65ec27.png">
### Tatoeba sentences
<img src=".img/97bc905fa6f0ea31314aa4c7fae16d4883d555184f7e65d7f1e41cd6a389148c.png">
## Installation
Binaries are directly available from the release tab.
## Compilation
Download source and run
```
make release
sudo make install
```
## Usage
A readline wrapper like `rlwrap` is strongly recommended if using `ykdt` interactively (-i or empty input).
```
ykdt [<words to look up>]
ykdt :[<radicals in kanji>]
ykdt _[<expressions in sentences>]
```
When looking up kanji, * (or ) can be used to add a radical that can't be easily typed, e.g. 气.
## Sources
Dictionary definitions retrieved using [jisho](jisho.org)'s API.
To search kanji by radicals, the [radkfile](https://www.edrdg.org/krad/kradinf.html) needs to be installed in either `~/.local/share/` on Linux or `~\AppData\Local\ `on Windows.
Kanji stroke information extracted from [kanjidic2](https://www.edrdg.org/kanjidic/kanjidic2.xml.gz).
Example sentences taken from [tatoeba](https://tatoeba.org/).