update readme a bit
Signed-off-by: dawn <90008@klbr.net>
12343456710 unmodified lines18192021232223242526272829303231323334353623 unmodified lines6061626364646566676842 unmodified lines1111121131141151151161171181171181191207 unmodified lines`chirami` pops up a little card at your pointer whenever you select japanesetext, with furigana, romaji, pitch accent, dictionary entries and kanji. itworks offline, on macos and linux (wayland). chirami (チラ見) is a quickpeek out of the corner of your eye, which is all it asks of you.works offline, on macos and linux (wayland).
at first the card only tells you how to read what you selected: furigana,10 unmodified lines
jisho.org is only asked when the offline dictionary has nothing for a wordwith kanji, never for kana, and `-offline` turns that off too.
## screenshots## ocr
take a screenshot of some japanese with your usual shortcut and the card popsup for the text in it. copying an image never does that, only screenshots.
on macos chirami watches for your screenshot shortcuts (remapped ones too) andreads the image with live text. on niri it follows niri's screenshot event andreads the image with meikiocr and manga-ocr on the cpu, after`chirami setup -ocr` downloads the models (~500 MB). other wayland compositorsdon't say when you took a screenshot, so there's no ocr there yet.don't say when you took a screenshot, so there's no ocr for those yet, therecan probably be for some but i didn't bother looking :p
## requirements
- macos 13 or newer, 14 for vertical text in screenshots. chirami asks for23 unmodified linesthen run `chirami setup` once. it builds the tokenizer data and downloads thedictionaries (~90 MB) into `~/Library/Application Support/chirami` or`$XDG_DATA_HOME/chirami` (`CHIRAMI_DATA` overrides), and then `chirami` runs it.
## running it all the time## setting up as a service
with home-manager, import the flake's `homeManagerModules.default` and set`services.chirami.enable = true;` (and `services.chirami.extraArgs` for flags).that's a systemd user service on linux and a launchd agent on macos.42 unmodified lines- ocr models: [meikiocr] (LGPL-3.0 weights, Apache-2.0 code) and [manga-ocr] (Apache-2.0)- fonts on linux: M PLUS Rounded 1c and Source Sans 3 (SIL OFL 1.1)
llms were also used while making this (a lot of it, honestly ^^).llms made this with feedback (thank you opus 5.5 and gemini 3.8 flash).
chirami is GPL-3.0-or-later.
[kagome]: https://github.com/ikawaha/kagome[JMdict]: https://www.edrdg.org/jmdict/j_jmdict.html[KANJIDIC2]: https://www.edrdg.org/wiki/index.php/KANJIDIC_Project[JMnedict]: https://www.edrdg.org/enamdict/enamdict_doc.html7 unmodified lines