aboutsummaryrefslogtreecommitdiffstats
path: root/doc/manual
diff options
context:
space:
mode:
authorNik Nyby <nnyby@columbia.edu>2015-10-24 11:50:56 -0400
committerNik Nyby <nnyby@columbia.edu>2015-10-24 11:50:56 -0400
commitaf0fdf2afd5b42a041d97f33170d17d6f18253af (patch)
treeb31f8c59c4ed9d05fa5eaa2f95a204a1f46787f6 /doc/manual
parentda101e8eb9da3808b3bd75d571e40d5c2f139d9d (diff)
parent59597067c21e52ae94340801d4bf6e3a9825c7a3 (diff)
downloadlibrejsxul-af0fdf2afd5b42a041d97f33170d17d6f18253af.tar.lz
librejsxul-af0fdf2afd5b42a041d97f33170d17d6f18253af.tar.xz
librejsxul-af0fdf2afd5b42a041d97f33170d17d6f18253af.zip
Merge pull request #5 from nikolas/jpm
jpm
Diffstat (limited to 'doc/manual')
-rw-r--r--doc/manual/html_node/Installation-Requirements.html46
-rw-r--r--doc/manual/html_node/Installation.html2
-rw-r--r--doc/manual/html_node/index.html2
-rw-r--r--doc/manual/index.html2
-rw-r--r--doc/manual/librejs.dvi.gzbin32350 -> 32103 bytes
-rw-r--r--doc/manual/librejs.html45
-rw-r--r--doc/manual/librejs.html.gzbin21395 -> 21250 bytes
-rw-r--r--doc/manual/librejs.html_node.tar.gzbin23391 -> 23250 bytes
-rw-r--r--doc/manual/librejs.info.tar.gzbin19151 -> 18979 bytes
-rw-r--r--doc/manual/librejs.pdfbin206511 -> 206232 bytes
-rw-r--r--doc/manual/librejs.texi.tar.gzbin18873 -> 18692 bytes
-rw-r--r--doc/manual/librejs.txt48
-rw-r--r--doc/manual/librejs.txt.gzbin18124 -> 17966 bytes
13 files changed, 48 insertions, 97 deletions
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&rsquo;re using a
compatible Mozilla browser.
</p>
-<a name="Mozilla_0027s-Add_002don-SDK"></a>
-<h3 class="appendixsec">A.2 Mozilla&rsquo;s Add-on SDK</h3>
-<p>LibreJS uses the Mozilla Add-on SDK (Software Development Kit), a
-set of APIs and tools to create add-ons for Mozilla browsers.
+<a name="Mozilla_0027s-Jetpack-Manager-for-Node_002ejs"></a>
+<h3 class="appendixsec">A.2 Mozilla&rsquo;s Jetpack Manager for Node.js</h3>
+<p>LibreJS uses the Mozilla <code>jpm</code> tool, a set of utilities for
+creating, testing, running and packaging Mozilla Jetpack Addons.
</p>
-<p>You do not need the Add-on SDK to use LibreJS xpi file or to install it
+<p>You do not need <code>jpm</code> 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 <code>make</code>. 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 &ldquo;make&rdquo; command to work
-properly, you must have the <code>cfx</code> 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 <code>jpm</code> as well. For the &ldquo;make&rdquo; command to work
+properly, you must have the <code>jpm</code> command available on your system
from the command line.
</p>
-<p>The latest tarball for the Add-on SDK is available at:
+<p>You can find information on getting <code>jpm</code> at these links:
</p>
-<p><a href="https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/jetpack-sdk-latest.tar.gz">https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/jetpack-sdk-latest.tar.gz</a>
+<p><a href="https://www.npmjs.com/package/jpm">https://www.npmjs.com/package/jpm</a>
</p>
-<p>Instructions on how to get it working are available here:
+<p><a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_%28jpm%29">https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_%28jpm%29</a>
</p>
-<p><a href="https://addons.mozilla.org/en-US/developers/docs/sdk/latest/dev-guide/tutorials/installation.html">https://addons.mozilla.org/en-US/developers/docs/sdk/latest/dev-guide/tutorials/installation.html</a>
+<p>JPM is released under the Mozilla Public License 2.0.
</p>
-<p>In order to use <code>make</code> with LibreJS source, however, it is ideal to
-have <code>cfx</code> available at all times and for all users.
-</p>
-<p>An easy way to do this is to extract the contents of the tarball and to
-place the files inside <samp>/usr/lib/addon-sdk</samp> and then creating a
-symbolic link in <samp>/usr/bin</samp>, as follows:
-</p>
-<div class="example">
-<pre class="example">sudo ln -s /usr/lib/addon-sdk/bin/cfx /usr/bin/cfx
-</pre></div>
-
-<p>The <code>cfx</code> command will then be available to all users.
-</p>
-<p>The Add-on SDK is released under the Mozilla Public License 2.0.
-</p>
-<hr>
-<div class="header">
-<p>
-Next: <a href="LibreJS-Internals.html#LibreJS-Internals" accesskey="n" rel="next">LibreJS Internals</a>, Previous: <a href="LibreJS-Development-Notes.html#LibreJS-Development-Notes" accesskey="p" rel="prev">LibreJS Development Notes</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
-</div>
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.
<a name="Building-the-Package"></a>
<h3 class="section">3.1 Building the Package</h3>
-<p>After enabling the Add-on SDK, you should be able to use the <code>make</code>
+<p>After installing <code>jpm</code>, you should be able to use the <code>make</code>
command to build LibreJS from source.
</p>
<p>After running <code>make</code>, a new file, <samp>librejs.xpi</samp> 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}
<li><a name="toc-Installation-Requirements-1" href="Installation-Requirements.html#Installation-Requirements">Appendix A Installation Requirements</a>
<ul class="no-bullet">
<li><a name="toc-Mozilla-Browser" href="Installation-Requirements.html#Mozilla-Browser">A.1 Mozilla Browser</a></li>
- <li><a name="toc-Mozilla_0027s-Add_002don-SDK" href="Installation-Requirements.html#Mozilla_0027s-Add_002don-SDK">A.2 Mozilla&rsquo;s Add-on SDK</a></li>
+ <li><a name="toc-Mozilla_0027s-Jetpack-Manager-for-Node_002ejs" href="Installation-Requirements.html#Mozilla_0027s-Jetpack-Manager-for-Node_002ejs">A.2 Mozilla&rsquo;s Jetpack Manager for Node.js</a></li>
</ul></li>
<li><a name="toc-LibreJS-Internals-1" href="LibreJS-Internals.html#LibreJS-Internals">Appendix B LibreJS Internals</a></li>
<li><a name="toc-Tests-1" href="Tests.html#Tests">Appendix C Tests</a></li>
diff --git a/doc/manual/index.html b/doc/manual/index.html
index 5f3b6f6..2e989e9 100644
--- a/doc/manual/index.html
+++ b/doc/manual/index.html
@@ -5,7 +5,7 @@
<h2>GNU LibreJS Manual</h2>
<address>Free Software Foundation</address>
-<address>last updated October 22, 2015</address>
+<address>last updated October 23, 2015</address>
<p>This manual (librejs) is available in the following formats:</p>
diff --git a/doc/manual/librejs.dvi.gz b/doc/manual/librejs.dvi.gz
index 74a1b40..cf1dba2 100644
--- a/doc/manual/librejs.dvi.gz
+++ b/doc/manual/librejs.dvi.gz
Binary files differ
diff --git a/doc/manual/librejs.html b/doc/manual/librejs.html
index 8569cd8..14c0847 100644
--- a/doc/manual/librejs.html
+++ b/doc/manual/librejs.html
@@ -108,7 +108,7 @@ ul.no-bullet {list-style: none}
<li><a name="toc-Installation-Requirements-1" href="#Installation-Requirements">Appendix A Installation Requirements</a>
<ul class="no-bullet">
<li><a name="toc-Mozilla-Browser" href="#Mozilla-Browser">A.1 Mozilla Browser</a></li>
- <li><a name="toc-Mozilla_0027s-Add_002don-SDK" href="#Mozilla_0027s-Add_002don-SDK">A.2 Mozilla&rsquo;s Add-on SDK</a></li>
+ <li><a name="toc-Mozilla_0027s-Jetpack-Manager-for-Node_002ejs" href="#Mozilla_0027s-Jetpack-Manager-for-Node_002ejs">A.2 Mozilla&rsquo;s Jetpack Manager for Node.js</a></li>
</ul></li>
<li><a name="toc-LibreJS-Internals-1" href="#LibreJS-Internals">Appendix B LibreJS Internals</a></li>
<li><a name="toc-Tests-1" href="#Tests">Appendix C Tests</a></li>
@@ -219,7 +219,7 @@ file, or by building it from source.
<a name="Building-the-Package"></a>
<h3 class="section">3.1 Building the Package</h3>
-<p>After enabling the Add-on SDK, you should be able to use the <code>make</code>
+<p>After installing <code>jpm</code>, you should be able to use the <code>make</code>
command to build LibreJS from source.
</p>
<p>After running <code>make</code>, a new file, <samp>librejs.xpi</samp> should be
@@ -848,41 +848,26 @@ LibreJS has been tested extensively on multiple GNU/Linux distributions,
but it is compatible any operating system as long as you&rsquo;re using a
compatible Mozilla browser.
</p>
-<a name="Mozilla_0027s-Add_002don-SDK"></a>
-<h3 class="appendixsec">A.2 Mozilla&rsquo;s Add-on SDK</h3>
-<p>LibreJS uses the Mozilla Add-on SDK (Software Development Kit), a
-set of APIs and tools to create add-ons for Mozilla browsers.
+<a name="Mozilla_0027s-Jetpack-Manager-for-Node_002ejs"></a>
+<h3 class="appendixsec">A.2 Mozilla&rsquo;s Jetpack Manager for Node.js</h3>
+<p>LibreJS uses the Mozilla <code>jpm</code> tool, a set of utilities for
+creating, testing, running and packaging Mozilla Jetpack Addons.
</p>
-<p>You do not need the Add-on SDK to use LibreJS xpi file or to install it
+<p>You do not need <code>jpm</code> 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 <code>make</code>. 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 &ldquo;make&rdquo; command to work
-properly, you must have the <code>cfx</code> 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 <code>jpm</code> as well. For the &ldquo;make&rdquo; command to work
+properly, you must have the <code>jpm</code> command available on your system
from the command line.
</p>
-<p>The latest tarball for the Add-on SDK is available at:
+<p>You can find information on getting <code>jpm</code> at these links:
</p>
-<p><a href="https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/jetpack-sdk-latest.tar.gz">https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/jetpack-sdk-latest.tar.gz</a>
+<p><a href="https://www.npmjs.com/package/jpm">https://www.npmjs.com/package/jpm</a>
</p>
-<p>Instructions on how to get it working are available here:
+<p><a href="https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_%28jpm%29">https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_%28jpm%29</a>
</p>
-<p><a href="https://addons.mozilla.org/en-US/developers/docs/sdk/latest/dev-guide/tutorials/installation.html">https://addons.mozilla.org/en-US/developers/docs/sdk/latest/dev-guide/tutorials/installation.html</a>
-</p>
-<p>In order to use <code>make</code> with LibreJS source, however, it is ideal to
-have <code>cfx</code> available at all times and for all users.
-</p>
-<p>An easy way to do this is to extract the contents of the tarball and to
-place the files inside <samp>/usr/lib/addon-sdk</samp> and then creating a
-symbolic link in <samp>/usr/bin</samp>, as follows:
-</p>
-<div class="example">
-<pre class="example">sudo ln -s /usr/lib/addon-sdk/bin/cfx /usr/bin/cfx
-</pre></div>
-
-<p>The <code>cfx</code> command will then be available to all users.
-</p>
-<p>The Add-on SDK is released under the Mozilla Public License 2.0.
+<p>JPM is released under the Mozilla Public License 2.0.
</p>
<hr>
<a name="LibreJS-Internals"></a>
diff --git a/doc/manual/librejs.html.gz b/doc/manual/librejs.html.gz
index f1c2743..6a7177f 100644
--- a/doc/manual/librejs.html.gz
+++ b/doc/manual/librejs.html.gz
Binary files differ
diff --git a/doc/manual/librejs.html_node.tar.gz b/doc/manual/librejs.html_node.tar.gz
index d5a9c88..d2eea99 100644
--- a/doc/manual/librejs.html_node.tar.gz
+++ b/doc/manual/librejs.html_node.tar.gz
Binary files differ
diff --git a/doc/manual/librejs.info.tar.gz b/doc/manual/librejs.info.tar.gz
index 72a1a41..cc42d53 100644
--- a/doc/manual/librejs.info.tar.gz
+++ b/doc/manual/librejs.info.tar.gz
Binary files differ
diff --git a/doc/manual/librejs.pdf b/doc/manual/librejs.pdf
index c464ae2..250acb7 100644
--- a/doc/manual/librejs.pdf
+++ b/doc/manual/librejs.pdf
Binary files differ
diff --git a/doc/manual/librejs.texi.tar.gz b/doc/manual/librejs.texi.tar.gz
index 640a41d..a091cc4 100644
--- a/doc/manual/librejs.texi.tar.gz
+++ b/doc/manual/librejs.texi.tar.gz
Binary files differ
diff --git a/doc/manual/librejs.txt b/doc/manual/librejs.txt
index 5ae723b..dcbe22a 100644
--- a/doc/manual/librejs.txt
+++ b/doc/manual/librejs.txt
@@ -24,7 +24,7 @@ LibreJS
8.4 Releasing a new version
Appendix A Installation Requirements
A.1 Mozilla Browser
- A.2 Mozilla's Add-on SDK
+ A.2 Mozilla's Jetpack Manager for Node.js
Appendix B LibreJS Internals
Appendix C Tests
Appendix D GNU Free Documentation License
@@ -72,8 +72,8 @@ 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'
-command to build LibreJS from source.
+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 generated.
This is the file that can be installed in a Mozilla browser.
@@ -611,40 +611,26 @@ 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.
-
- You do not need the Add-on SDK to use 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 from
-the command line.
-
- The latest tarball for the Add-on SDK is available at:
-
- <https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/jetpack-sdk-latest.tar.gz>
-
- Instructions on how to get it working are available here:
+A.2 Mozilla's Jetpack Manager for Node.js
+=========================================
- <https://addons.mozilla.org/en-US/developers/docs/sdk/latest/dev-guide/tutorials/installation.html>
+LibreJS uses the Mozilla 'jpm' tool, a set of utilities for creating,
+testing, running and packaging Mozilla Jetpack Addons.
- In order to use 'make' with LibreJS source, however, it is ideal to
-have 'cfx' available at all times and for all users.
+ 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. 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.
- 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:
+ You can find information on getting 'jpm' at these links:
- sudo ln -s /usr/lib/addon-sdk/bin/cfx /usr/bin/cfx
+ <https://www.npmjs.com/package/jpm>
- The 'cfx' command will then be available to all users.
+ <https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_%28jpm%29>
- The Add-on SDK is released under the Mozilla Public License 2.0.
+ JPM is released under the Mozilla Public License 2.0.
Appendix B LibreJS Internals
****************************
diff --git a/doc/manual/librejs.txt.gz b/doc/manual/librejs.txt.gz
index 4c3514b..8141d68 100644
--- a/doc/manual/librejs.txt.gz
+++ b/doc/manual/librejs.txt.gz
Binary files differ