From 6fadce1cd8881b2a144be5aaf99966dfd6093860 Mon Sep 17 00:00:00 2001
From: hackademix <giorgio@maone.net>
Date: Mon, 8 Oct 2018 18:27:12 +0200
Subject: Added dependencies and testing sections.

---
 docs/librejs.info | 53 +++++++++++++++++++++++++++++++++++++++++++++--------
 docs/man.texi     | 44 +++++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 88 insertions(+), 9 deletions(-)

(limited to 'docs')

diff --git a/docs/librejs.info b/docs/librejs.info
index fcd1ef1..0520e19 100644
--- a/docs/librejs.info
+++ b/docs/librejs.info
@@ -382,7 +382,36 @@ File: librejs.info,  Node: LibreJS Development Notes,  Next: Installation Requir
 8 LibreJS Development Notes
 ***************************
 
-8.1 Debugging
+8.1 Dependencies
+================
+
+LibreJS 7.17 depends on a number of Node.js-based libraries that can be
+installed using the 'npm' utility:
+
+  $ npm install acorn-loose
+  $ npm install jssha
+  $ npm install browserify
+  $ export PATH=$PATH:./node_modules/.bin
+
+8.2 Building
+============
+
+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.
+
+8.3 Debugging
 =============
 
 To debug LibreJS, visit the special URL 'about:debugging'.  Click on
@@ -393,7 +422,15 @@ LibreJS's unpacked source directory and select 'manifest.json'.
 controlling the verbosity of 'dbg_print()' statements.  Make sure these
 are set to false before building a release.
 
-8.2 Adding new whitelisted libraries
+8.4 Testing
+===========
+
+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) it can be launched from the UI by
+clicking the "Automated self test..."  button.
+
+8.5 Adding new whitelisted libraries
 ====================================
 
 The script index.js in './hash_script' generates the default whitelist.
@@ -404,7 +441,7 @@ Run it with the following command:
    Then, just copy the contents of the file "output" to the appropriate
 place in main_background.js.
 
-8.3 Releasing a new version
+8.6 Releasing a new version
 ===========================
 
 Update the version number in manifest.json.
@@ -412,7 +449,7 @@ Update the version number in manifest.json.
    Make sure debug statements are set to false on lines 39/40 in
 'main_background.js'.
 
-   Then, run the build script 'build.sh'.  This
+   Then run the build script 'build.sh'.
 
 
 File: librejs.info,  Node: Installation Requirements,  Next: LibreJS Internals,  Prev: LibreJS Development Notes,  Up: Top
@@ -942,9 +979,9 @@ Node: How to Use3539
 Node: JavaScript Detection7045
 Node: Free Licenses Detection8332
 Node: Setting Your JavaScript Free8803
-Node: LibreJS Development Notes14531
-Node: Installation Requirements15691
-Node: LibreJS Internals16401
-Node: GNU Free Documentation License17051
+Node: LibreJS Development Notes14530
+Node: Installation Requirements16612
+Node: LibreJS Internals17322
+Node: GNU Free Documentation License17972
 
 End Tag Table
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
-- 
cgit v1.2.3