Yakudatsu/README.md
2023-11-21 18:07:15 +00:00

28 lines
916 B
Markdown
Raw 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.

# Jisho (cli)
A very simple cli tool to look up Japanese words using jisho.org's API.
Searching for kanji by radicals is also available.
<br>
<img src=".img/dab0ab082751a1b17271309c2ffc3c16d53c8498513619e50235e8157bab01fa.png">
<img src=".img/16adb8274ff5e12b13545df2996dbdc3be149b9cd5575ceb38e2d9e031117ab9.png">
# Installation
Binaries are directly available from the release tab.
# Compilation
Download source and run
```
cargo build --release
```
# Usage
A readline wrapper like `rlwrap` is strongly recommended if using `jisho-cli` interactively (-i).
```
jisho [<words to look up>]
jisho :[<radicals in kanji>]
```
When looking up radicals, * (or ) can be used to add a radical that can't be easily typed, e.g. 气.
# Note
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.