onedeuxtriseigo.nullpo.dev
Pop-up dictionary browser extension for language learning. Successor to Yomichan. (PERSONAL FORK)
Added loading builds instructions for firefox and edge on CONTRIBUTING (#2108)
* Added loading builds instructions for firefox and edge
* Included instruction for permanently adding extension to Firefox
authored by
leeseoji-24
and committed by
GitHub
4490dceb
665b78f4
+32
CONTRIBUTING.md
+32
CONTRIBUTING.md
···
78
79
Note: Yomitan may or may not update when you make and save new code changes locally. It depends on what file you've changed. Yomitan runs as collection of two programs. There is the background process called the "service worker" and there is the frontend called the "content_script". The frontend will reload on save, but to update the backend you need to click on the update icon next to the extension in `chrome://extensions/`. If you make changes to the manifest you will need to rerun `npm run build` to regenerate the manifest file.
80
81
### Build Tools
82
83
The build process can use the [7-zip](https://www.7-zip.org/) archiving tool to create the packed zip builds
···
78
79
Note: Yomitan may or may not update when you make and save new code changes locally. It depends on what file you've changed. Yomitan runs as collection of two programs. There is the background process called the "service worker" and there is the frontend called the "content_script". The frontend will reload on save, but to update the backend you need to click on the update icon next to the extension in `chrome://extensions/`. If you make changes to the manifest you will need to rerun `npm run build` to regenerate the manifest file.
80
81
+
### Loading a build into Firefox browser
82
+
83
+
After building, you can load the compiled extension into the Firefox browser.
84
+
85
+
- Navigate to the Debugging page, type `about:debugging` into the url
86
+
- Click on "This Firefox" on the left
87
+
- Click on "Load Temporary Add-on" on the right
88
+
- Navigate to the `yomitan-firefox-dev.zip` in your builds folder
89
+
90
+
Immediately you should see the "Welcome" page!
91
+
92
+
Note: The "Load Temporary Add-on" option is temporary and the build will need to be loaded again after browser restarts. Sometimes testing extension features between browser restarts will be necessary so here are the steps to bypass this restriction.
93
+
94
+
- Download Firefox Developer or Nightly
95
+
- Navigate to the Config page, type `about:config` into the url
96
+
- Look up `xpinstall.signatures.required` setting on the search bar at the top
97
+
- Toggle the value to "false"
98
+
- Navigate to the "Extensions" page using "Manage extensions"
99
+
- Either use drag and drop or "Install Add-on from File" to load the dev build
100
+
101
+
### Loading an unpacked build into Microsoft Edge browser
102
+
103
+
After building, you can load the compiled extension into the Edge browser.
104
+
105
+
- Unpack the `yomitan-edge.zip`
106
+
- Navigate to the extension page using the "..." on the top right and clicking on "Manage extensions"
107
+
- Turn on the toggle on the left that says "Developer Mode"
108
+
- Click "Load unpacked" on the top right
109
+
- Select the unpacked `yomitan-edge` folder
110
+
111
+
Immediately you should see the "Welcome" page!
112
+
113
### Build Tools
114
115
The build process can use the [7-zip](https://www.7-zip.org/) archiving tool to create the packed zip builds