Skip to content

Latest commit

 

History

History
105 lines (71 loc) · 4.55 KB

README.md

File metadata and controls

105 lines (71 loc) · 4.55 KB
Raw

Yomikiri

Yomikiri is a Japanese immersion learning tool. As you read Japanese text and encounter words you don't know, look up the meaning and add the word to Anki flashcards.

Yomikiri is available for Chrome, Firefox, and iOS.

Available in the Chrome Web Store Get the add-on for Firefox Download on the App Store

Features

  • Shift + Hover over a word to view definition. It recognizes word boundaries within sentence.

  • Search words and sentences in popup.

  • Add word to Anki. You can preview and edit the note before adding.
    If Anki is not running, notes are stored and automatically added later. You don't have to keep Anki running in the background all the time.

  • Customizable Anki note template.

  • View sentence translation.

  • View relevant grammar with a link to Tofugu.

Building from source

Please note that we do not support building the project on Windows. You may want to use WSL to build the project. The build system has only been tested on MacOS 14 (ARM) however, and may not quite work on Linux.

NodeJS, pnpm, Rust & cargo, wasm-pack must be installed.

To build for all targets, run the following commands. If you only need to build for desktop browser extension, go to later section instead.

# Add target to compile rust for ios
rustup target add aarch64-apple-ios
# install node dependencies
pnpm install
# Download files, build crates, and generate necessary files for release
pnpm generate:release

To build for ios simulator, also add target: rustup target add aarch64-apple-ios-sim.

Then run pnpm build:chrome, pnpm build:firefox, which builds desktop browser extensions into ./main/build/.

To build ios app, open /safari/Yomikiri.xcodeproj on XCode, and build.

Desktop browser extensions only

If you only need to build for desktop browser extensions only, you can run below command.

pnpm install
pnpm generate:release:web

Development

Steps to build for development is slightly different, as it skips some optimizations for faster build.

Run following commands to generate necessary files:

rustup target add aarch64-apple-ios
rustup target add aarch64-apple-ios-sim
# Create yomikiri dictionary files from JMDict.
# Must be run when 'yomikiri-dictionary' crate is modified
pnpm generate:dictionary
# Downloads and customizes UniDic tokenizer dictionary.
# Must be run when dictionary or 'unidic' crate is modified
pnpm generate:unidic
# Generates wasm and lib for backend.
# Must be run when dictionary, unidic, or 'yomikiri-backend' crate is modified.
pnpm generate:backend
# Collects licenses of dependencies. Only need to be run once.
pnpm generate:licenses

If you don't need to build for ios app, you can skip adding rustup target, and run generate:backend-wasm instead of generate:backend.

After modification, run pnpm format to fix formatting, pnpm lint to check for lint errors, and pnpm test to run tests. These commands are universal, and are defined in repo root, and all sub packages and crates where relevant.

Chrome

Run pnpm dev:chrome.

In Chrome, go to chrome://extensions/, toggle developer mode. Press 'Load unpacked' and open /main/build/chrome.

Firefox

Run pnpm dev:firefox.

In Firefox, type about:debugging in the url bar to open debugging menu. Switch to 'This Firefox' tab. Press 'Load Temporary Add-on...' and open /main/build/firefox/manifest.json.

IOS

Open /safari/Yomikiri.xcodeproj on XCode, and build. Building automatically bundles web files in ./main, but does not generate dictionary, unidic, or backend files.