Hiers/Yakudatsu
1
0
Fork 0
Code Issues Pull requests Projects Releases 5 Packages Wiki Activity Actions

Preparing for 1.0 release.

Browse source
This commit is contained in:
Hiers 2023-12-17 21:45:30 +00:00
parent 58d2c92e3a
commit feb73531cd
4 changed files with 20 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,10 +1,11 @@
# 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.
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.
<br>
<img src=".img/dab0ab082751a1b17271309c2ffc3c16d53c8498513619e50235e8157bab01fa.png">
<img src=".img/16adb8274ff5e12b13545df2996dbdc3be149b9cd5575ceb38e2d9e031117ab9.png">
<img src=".img/97bc905fa6f0ea31314aa4c7fae16d4883d555184f7e65d7f1e41cd6a389148c.png">
# Installation
Binaries are directly available from the release tab.
@ -17,12 +18,14 @@ cargo build --release
```
# Usage
A readline wrapper like `rlwrap` is strongly recommended if using `jisho-cli` interactively (-i).
A readline wrapper like `rlwrap` is strongly recommended if using `jisho-cli` interactively (-i or empty input).
```
jisho [<words to look up>]
jisho :[<radicals in kanji>]
jisho _[<expressions in sentences>]
```
When looking up radicals, * (or ＊) can be used to add a radical that can't be easily typed, e.g. 气.
When looking up kanji, * (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.
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.
Example sentences taken from [tatoeba](https://tatoeba.org/).