README


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

## LibreJS - WebExtensions Edition ##


BUILD:

First, you need to get some stuff with npm:
  $ npm install acorn-loose
  $ 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

To build the extension including the automated test suite (see TEST below) run:
  $ ./build.sh -t
  or
  $ ./build.sh --test

Note: this build.sh script relies on no new source files being created.


DEBUG:

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.

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.

TEST:

An automated test suite runs automatically in its own tab whenever the extension
is loaded as a "temporary add-on" from about:debugging.
Otherwise (if included in the xpi, see BUILD above) it can be launched from the
UI by clicking the [Automated self test...] button.

CONTACT:

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