aboutsummaryrefslogtreecommitdiff
path: root/yomichan/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'yomichan/readme.md')
-rw-r--r--yomichan/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/yomichan/readme.md b/yomichan/readme.md
new file mode 100644
index 0000000..97f9904
--- /dev/null
+++ b/yomichan/readme.md
@@ -0,0 +1,27 @@
+# yomichan patch stuff
+
+adds a user.js script to your config and settings page that runs in the search
+page and popup window.
+
+![](../assets/userscript.png)
+
+## set-up
+
+to download the latest yomichan version and patch it, leaving all files exposed
+for later updating (unpacked extension), run the following command:
+
+> updating is currently broken, so you have to run `make clean` before `make
+> patch` to prevent the .html.patch files from being applied twice
+
+```
+make patch
+```
+
+to patch yomichan and convert it back to a zip (packed extension, non-signed,
+for use with kiwi browser), run:
+
+```
+make yomichan-chrome-patched.zip
+```
+
+if you want to update the patch or zip, replace `make` with `make -B`.