Skip to content

Commit

Permalink
removed new dependency (was causing issues)
Browse files Browse the repository at this point in the history
  • Loading branch information
martholomew committed Nov 27, 2024
1 parent 253fd34 commit 6b1c6aa
Show file tree
Hide file tree
Showing 3 changed files with 217 additions and 5,443 deletions.
8 changes: 6 additions & 2 deletions docs/development/npm-scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,18 @@ Scripts can be executed by running `npm run <name>`.
Rebuilds all of the third-party dependencies that the extension uses.

- `build:serve:firefox-android`
Builds for Firefox and then uses `web-ext` to serve the extension through `adb` to Firefox for Android. `adb` is required to be installed on your computer. Prepend the environment variables WEB_EXT_TARGET and WEB_EXT_ADB_DEVICE for the command to succeed (example: `WEB_EXT_TARGET="firefox-android" WEB_EXT_ADB_DEVICE="emulator-5554" npm run build:serve:firefox-android`). WEB_EXT_TARGET will be "firefox-android" for vanilla Firefox, and you can find the value for WEB_EXT_ADB_DEVICE by running the command `adb devices`.

> [!IMPORTANT] > `adb` and `web-ext` are required to be installed on your computer for this command to work!
> Builds for Firefox and then uses `web-ext` to serve the extension through `adb` to Firefox for Android. Prepend the environment variables WEB_EXT_TARGET and WEB_EXT_ADB_DEVICE for the command to succeed (example: `WEB_EXT_TARGET="firefox-android" WEB_EXT_ADB_DEVICE="emulator-5554" npm run build:serve:firefox-android`). WEB_EXT_TARGET will be "firefox-android" for vanilla Firefox, and you can find the value for WEB_EXT_ADB_DEVICE by running the command `adb devices`.
[Get started debugging Firefox for Android (recommended)](https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/#test-and-degug-an-extention)

[`web-ext run` documentation](https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#web-ext-run)

- `build:serve:kiwi-browser`
Builds for Chromium and then uses `adb` to `push` the built zip file over to `/sdcard/yomitan`. You can then open up Kiwi Browser on the target phone and install the extension through that zip file. `adb` is required to be installed on your computer

> [!IMPORTANT] > `adb` is required to be installed on your computer for this command to work!
> Builds for Chromium and then uses `adb` to `push` the built zip file over to `/sdcard/yomitan`. You can then open up Kiwi Browser on the target phone and install the extension through that zip file.
- `test`
Runs all of the tests.
Expand Down
Loading

0 comments on commit 6b1c6aa

Please sign in to comment.