aboutsummaryrefslogtreecommitdiff
path: root/docs/man.texi
diff options
context:
space:
mode:
authorhackademix <giorgio@maone.net>2018-10-08 18:27:12 +0200
committerhackademix <giorgio@maone.net>2018-10-08 18:27:12 +0200
commit6fadce1cd8881b2a144be5aaf99966dfd6093860 (patch)
tree644cea2f49e31c224206d388947cc16ce13fab6d /docs/man.texi
parent2aeaa93bd591e4ea16c558a78b3c09b09c7645e8 (diff)
Added dependencies and testing sections.
Diffstat (limited to 'docs/man.texi')
-rw-r--r--docs/man.texi44
1 files changed, 43 insertions, 1 deletions
diff --git a/docs/man.texi b/docs/man.texi
index 36c0934..a9db799 100644
--- a/docs/man.texi
+++ b/docs/man.texi
@@ -408,6 +408,41 @@ Many free licenses are listed in this page:
@node LibreJS Development Notes
@chapter LibreJS Development Notes
+@section Dependencies
+
+LibreJS @value{VERSION} depends on a number of Node.js-based libraries that
+can be installed using the @code{npm} utility:
+
+@verbatim
+ $ npm install acorn-loose
+ $ npm install jssha
+ $ npm install browserify
+ $ export PATH=$PATH:./node_modules/.bin
+@end verbatim
+
+@section Building
+
+To build the extension run:
+@verbatim
+ $ browserify main_background.js -o bundle.js
+@end verbatim
+
+To build the extension plus create a .xpi package run:
+@verbatim
+ $ ./build.sh
+@end verbatim
+
+To build the extension including the automated test suite (see TEST below) run:
+@verbatim
+ $ ./build.sh -t
+@end verbatim
+or
+@verbatim
+ $ ./build.sh --test
+@end verbatim
+
+Note: this @file{build.sh} script relies on no new source files being created.
+
@section Debugging
To debug LibreJS, visit the special URL @code{about:debugging}. Click
@@ -418,6 +453,13 @@ Lines 39 and 40 in @file{main_background.js} assign two variables controlling
the verbosity of @code{dbg_print()} statements. Make sure these are set to false
before building a release.
+@section Testing
+
+An automated test suite runs automatically in its own tab whenever the extension
+is loaded as a "Temporary add-on" from @code{about:debugging}.
+Otherwise (if included in the xpi) it can be launched from the
+UI by clicking the "Automated self test..." button.
+
@section Adding new whitelisted libraries
The script index.js in @file{./hash_script} generates the default
@@ -435,7 +477,7 @@ Update the version number in manifest.json.
Make sure debug statements are set to false on lines 39/40 in
@file{main_background.js}.
-Then, run the build script @file{build.sh}. This
+Then run the build script @file{build.sh}.
@node Installation Requirements
@appendix Installation Requirements