diff options
| author | bill-auger <mr.j.spam.me@gmail.com> | 2018-02-25 09:29:08 -0500 |
|---|---|---|
| committer | bill-auger <mr.j.spam.me@gmail.com> | 2018-02-28 22:36:33 -0500 |
| commit | 22ccf48592e90d0a1684b4236d96b99cd29b4d93 (patch) | |
| tree | bea6d8912f62ad16c18c71b1c4618bb9b701dcce /README | |
| parent | e52d93da98bffcb51f6d6b98f6106fd206b4e681 (diff) | |
housekeeping
Diffstat (limited to 'README')
| -rw-r--r-- | README | 36 |
1 files changed, 21 insertions, 15 deletions
@@ -1,27 +1,33 @@ -# LibreJS-webex +## LibreJS - WebExtensions Edition ## -Port of LibreJS to webExtensions. -It is lacking some license information for the assets from the original LibreJS. Not sure what license should be used for the new source files either. Also, we probably want to sort out the licenses for the dependencies (Acorn Javascript parser and jsSHA) to make sure they are cited correctly. - -TO BUILD: +BUILD: First, you need to get some stuff with npm: + $ npm install acorn + $ npm install jssha + $ npm install browserify + $ export PATH=$PATH:./node_modules/.bin + +To build the extension run: + $ browserify main_background.js -o bundle.js + +To build the extension plus create a .xpi package run: + $ ./build.sh -npm install acorn -npm install jssha -npm install browserify +Note: this build.sh script relies on no new source files being created. -To build the extension run this: -browserify main_background.js -o bundle.js +DEBUG: -To create an XPI file that can be uploaded to Mozilla run build.sh. +To debug this add-on on IceCat and other Firefox derivatives, browse to the special URL "about:debugging", select "Enable add-on debugging", and load the manifest.json in this directory with the "Load Temporary Add-on" button. -Note: this build script relies on no new source files being created. +LibreJS should work with other WebExtensions-compliant browsers; but currently, none of them meet the freedom standards of GNU, so no help will be provided for their usage. -To debug this add-on on Firefox, go to the special URL "about:debugging", enable add-on debugging load the manifest.json. -Chrome should work eventually but I haven't tested it lately. To debug the add-on on Chrome it's basically the same except you load it from "chrome://extensions" +CONTACT: -Mailing list: bug-librejs@gnu.org +Development mailing list: bug-librejs@gnu.org +Users mailing list: help-librejs@gnu.org +Subscribe URL: https://savannah.gnu.org/mail/?group=librejs +Bug Reports: https://savannah.gnu.org/bugs/?group=librejs |