From 3408c70243f8f9097feed86df427d975d23cc538 Mon Sep 17 00:00:00 2001 From: Nik Nyby Date: Sat, 27 Jun 2015 10:55:46 -0400 Subject: update docs for jpm --- .../html_node/Installation-Requirements.html | 46 ++++++---------------- doc/manual/html_node/Installation.html | 2 +- doc/manual/html_node/index.html | 2 +- 3 files changed, 15 insertions(+), 35 deletions(-) (limited to 'doc/manual/html_node') diff --git a/doc/manual/html_node/Installation-Requirements.html b/doc/manual/html_node/Installation-Requirements.html index 720d26b..61db3c3 100644 --- a/doc/manual/html_node/Installation-Requirements.html +++ b/doc/manual/html_node/Installation-Requirements.html @@ -84,47 +84,27 @@ LibreJS has been tested extensively on multiple GNU/Linux distributions, but it is compatible any operating system as long as you’re using a compatible Mozilla browser.

- -

A.2 Mozilla’s Add-on SDK

-

LibreJS uses the Mozilla Add-on SDK (Software Development Kit), a -set of APIs and tools to create add-ons for Mozilla browsers. + +

A.2 Mozilla’s Jetpack Manager for Node.js

+

LibreJS uses the Mozilla jpm tool, a set of utilities for +creating, testing, running and packaging Mozilla Jetpack Addons.

-

You do not need the Add-on SDK to use LibreJS xpi file or to install it +

You do not need jpm to use the LibreJS xpi file or to install it using the packaged version, but it is required in order to package the -LibreJS source code into an xpi file using make. If you would like -to run the tests for LibreJS or make changes to the source files, you -will need the Add-on SDK as well. For the “make” command to work -properly, you must have the cfx command available on your system +LibreJS source code into an xpi file. If you would like to run the +tests for LibreJS or make changes to the source files, you +will need jpm as well. For the “make” command to work +properly, you must have the jpm command available on your system from the command line.

-

The latest tarball for the Add-on SDK is available at: +

You can find information on getting jpm at these links:

-

https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/jetpack-sdk-latest.tar.gz +

https://www.npmjs.com/package/jpm

-

Instructions on how to get it working are available here: +

https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_%28jpm%29

-

https://addons.mozilla.org/en-US/developers/docs/sdk/latest/dev-guide/tutorials/installation.html +

JPM is released under the Mozilla Public License 2.0.

-

In order to use make with LibreJS source, however, it is ideal to -have cfx available at all times and for all users. -

-

An easy way to do this is to extract the contents of the tarball and to -place the files inside /usr/lib/addon-sdk and then creating a -symbolic link in /usr/bin, as follows: -

-
-
sudo ln -s /usr/lib/addon-sdk/bin/cfx /usr/bin/cfx
-
- -

The cfx command will then be available to all users. -

-

The Add-on SDK is released under the Mozilla Public License 2.0. -

-
-
-

-Next: , Previous: , Up: Top   [Contents]

-
diff --git a/doc/manual/html_node/Installation.html b/doc/manual/html_node/Installation.html index cc65d82..de5dac5 100644 --- a/doc/manual/html_node/Installation.html +++ b/doc/manual/html_node/Installation.html @@ -76,7 +76,7 @@ file, or by building it from source.

3.1 Building the Package

-

After enabling the Add-on SDK, you should be able to use the make +

After installing jpm, you should be able to use the make command to build LibreJS from source.

After running make, a new file, librejs.xpi should be diff --git a/doc/manual/html_node/index.html b/doc/manual/html_node/index.html index b7e668d..41b9b4b 100644 --- a/doc/manual/html_node/index.html +++ b/doc/manual/html_node/index.html @@ -109,7 +109,7 @@ ul.no-bullet {list-style: none}

  • Appendix A Installation Requirements
  • Appendix B LibreJS Internals
  • Appendix C Tests
    • -- cgit v1.2.3