summaryrefslogtreecommitdiff
path: root/dist
diff options
context:
space:
mode:
authorTrent Robbins <robbintt@gmail.com>2017-05-26 04:30:02 -0700
committerRaymond Hill <gorhill@users.noreply.github.com>2017-05-26 07:30:02 -0400
commit56b0b0c33004cf8ff62a17759ed54b810e854cdd (patch)
treea73064ad4b9da6ed2ba7329bcbc27f17d78c0180 /dist
parent5f7354476b4f47e2355c79c43a664f3a441c4e19 (diff)
Added build instructions to dist/README.md (#2648)
Diffstat (limited to 'dist')
-rw-r--r--dist/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/dist/README.md b/dist/README.md
index 9832fd3a..e334280e 100644
--- a/dist/README.md
+++ b/dist/README.md
@@ -16,6 +16,15 @@
The extension will now be available in your chromium/chromium-based browser.
+##### Chromium Build Instructions (for developers)
+
+- Clone [uBlock](https://github.com/gorhill/uBlock) and [uAssets](https://github.com/uBlockOrigin/uAssets) repositories in the same parent directory
+- Set path to uBlock: `cd uBlock`
+- Optional: Select the version to build: `git checkout <tag>`
+- Build the plugin: `./tools/make-chromium.sh`
+- Load the unpacked extension folder `/uBlock/dist/build/uBlock0.chromium/` in Chromium to use the extension
+
+
Remember that you have to update manually also. For some users, updating manually is actually an advantage because:
- You can update when **you** want
- If ever a new version sucks, you can easily just re-install the previous one