Skip to content
This repository has been archived by the owner on Feb 26, 2022. It is now read-only.

Commit

Permalink
Bug 613577 - direct tutorial readers to skip download/install section…
Browse files Browse the repository at this point in the history
… if they have already done so; r=myk
  • Loading branch information
Will Bamberg committed May 23, 2011
1 parent 9a7f59b commit 9648dd1
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 61 deletions.
2 changes: 1 addition & 1 deletion static-files/base.html
Expand Up @@ -37,12 +37,12 @@ <h2 class="sidebar-section-header"><a href="dev-guide/addon-development/about.ht
<div class="sidebar-section-contents" id="default-section-contents">

<div class="sidebar-subsection">
<h3><a href="dev-guide/addon-development/installation.html">Installation</a></h3>
<h3 class="sidebar-subsection-header"><a href="dev-guide/addon-development/tutorials.html">Tutorials</a></h3>
<div class="sidebar-subsection-contents">
<ul>
<li><h4><a href="dev-guide/addon-development/getting-started.html">Getting Started</a></h4>
<ul>
<li><a href="dev-guide/addon-development/installation.html">Installation</a></li>
<li><a href="dev-guide/addon-development/implementing-simple-addon.html">A Simple Add-on</a></li>
<li><a href="dev-guide/addon-development/commonjs.html">CommonJS</a></li>
<li><a href="dev-guide/addon-development/implementing-reusable-module.html">Reusable Modules</a></li>
Expand Down
Expand Up @@ -3,10 +3,6 @@
This tutorial provides a practical step by step introduction to developing
add-ons with the SDK.

### [Installation](dev-guide/addon-development/installation.html) ###
Explains the prerequisites for running the SDK and how to install
it.

### [A Simple Add-on](dev-guide/addon-development/implementing-simple-addon.html) ###
Takes you through the process of implementing, running, and packaging a simple
add-on.
Expand Down
84 changes: 35 additions & 49 deletions static-files/md/dev-guide/addon-development/installation.md
@@ -1,58 +1,39 @@
# Installation #

## Prerequisites ##

To develop with the new Add-on SDK, you'll need:

<div class="aside">
Verify that Python is in your path.
</div>
To develop with the Add-on SDK, you'll need:

* [Python](http://www.python.org/) 2.5 or 2.6. Note that versions 3.0 and 3.1
of Python are not supported in this release.

* A working version of Firefox that uses Gecko 2.0.0.7 or later
(e.g., Firefox 4.0b7).
of Python are not supported. Make sure that Python is in your path.

## Installation ##
* A version of Firefox that uses Gecko 2.0.0.7 or later
(for example, Firefox 4.0).

<span class="aside">
Alternatively, you can get the latest development version of the
Add-on SDK from its
[GitHub repository](https://github.com/mozilla/addon-sdk).
</span>

At the time of this writing, the latest stable version of the Add-on
SDK is 1.0b6pre. You can obtain it as a
At the moment, the latest stable version of the Add-on SDK is 1.0b5.
You can obtain it as a
[tarball](https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/jetpack-sdk-latest.tar.gz)
or a [zip file](https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/jetpack-sdk-latest.zip).
Alternatively, you can get the latest development version of the
Add-on SDK from its [GitHub repository](https://github.com/mozilla/addon-sdk).

Extract the file contents wherever you choose, and navigate to the root
directory of the SDK with a shell/command prompt. For example:

<pre>
~/mozilla > tar -xf addon-sdk-1.0b4.tar.gz
~/mozilla > cd addon-sdk-1.0b4
~/mozilla/addon-sdk-1.0b4 >
~/mozilla > tar -xf addon-sdk-1.0b5.tar.gz
~/mozilla > cd addon-sdk-1.0b5
~/mozilla/addon-sdk-1.0b5 >
</pre>

<span class="aside">
Unlike many development tools, there isn't a system-wide location for
the Add-on SDK. Instead, developers can have as many installations of
the SDK as they want, each configured separately from one
another. Each installation is called a *virtual environment*.
</span>

Then, if you're on Linux, OS X, or another Unix-based system, run:

<pre>
~/mozilla/addon-sdk-1.0b4 > source bin/activate
~/mozilla/addon-sdk-1.0b5 > source bin/activate
</pre>

Otherwise, if you're on Windows, run:

<pre>
C:\Users\Mozilla\addon-sdk-1.0b4> bin\activate
C:\Users\Mozilla\addon-sdk-1.0b5> bin\activate
</pre>

Now the beginning of your command prompt should contain the text
Expand All @@ -63,21 +44,21 @@ command-line tools.
At any time, you can leave a virtual environment by running
`deactivate`.

## Sanity Check ##
The virtual environment is specific to this particular command prompt. If you
close this command prompt, it is deactivated and you need to type
`source bin/activate` in a new command prompt to reactivate it. If
you open a new command prompt, the SDK will not be active in the new prompt.

You can have multiple copies of the SDK in different locations on disk and
switch between them, or even have them both activated in different command
prompts at the same time.

<span class="aside">
Unit and behavioral testing is something that
we're trying to make as easy and fast as possible in the Add-on SDK,
because it's imperative that we know when breakages occur between the
Mozilla platform and the SDK. We also need to make sure that creating
new functionality or modifying existing code doesn't break other
things.
</span>
## Sanity Check ##

Run this at your shell prompt:

<pre>
~/mozilla/addon-sdk-1.0b4 > cfx
~/mozilla/addon-sdk-1.0b5 > cfx
</pre>

It should produce output whose first line looks something like this, followed by
Expand All @@ -93,12 +74,17 @@ add-on for distribution, view documentation, and run unit tests.

## cfx docs ##

Before we begin, if the page you're reading right now isn't hosted at
`127.0.0.1` or `localhost`, you should run `cfx docs`
immediately. This will run a self-hosted documentation server and open
it in your web browser.
If you're reading these documents online, try running `cfx docs`. This will
run a self-hosted documentation server and open it in your web browser.

## Problems? ##

Try the [Troubleshooting](dev-guide/addon-development/troubleshooting.html)
page.

## Implementing an add-on ##
## Next Steps ##

Next we'll go through the process of [implementing a
simple add-on](dev-guide/addon-development/implementing-simple-addon.html).
Next, take a look at the
[Getting Started](dev-guide/addon-development/getting-started.html) tutorial,
which explains the basic concepts behind the SDK and walks through a simple
example.
3 changes: 2 additions & 1 deletion static-files/md/dev-guide/addon-development/tutorials.md
@@ -1,7 +1,8 @@
# Tutorials #

### [Getting Started](dev-guide/addon-development/getting-started.html) ###
Takes you through installing the SDK and creating a simple add-on.
In this tutorial we'll implement a simple add-on and introduce the main
concepts in the SDK.

### [Introducing the APIs](dev-guide/addon-development/api-intro.html) ###
An introduction to the SDK APIs.
Expand Down
15 changes: 9 additions & 6 deletions static-files/md/dev-guide/welcome.md
@@ -1,7 +1,9 @@
# Add-on Development Made Easy #

The Add-on SDK is designed to make it easy to develop Firefox add-ons. It
includes:
Using the Add-on SDK you can create add-ons using standard Web technologies:
JavaScript, HTML, and CSS.

The SDK includes:

* A set of modules providing JavaScript APIs which you can
use to create add-ons. These modules simplify tasks such as building a user
Expand All @@ -12,10 +14,11 @@ continues to work as new versions of Firefox are released.

We've divided the SDK documentation into two parts:

The [Developer Guide](dev-guide/addon-development/about.html) explains how to use the
SDK to build add-ons. If you're new to the SDK start with the [Getting
Started](dev-guide/addon-development/getting-started.html) tutorial.
* The [Developer Guide](dev-guide/addon-development/about.html) explains how to
[install the SDK](dev-guide/addon-development/installation.html) and how to
use it to build add-ons. If you're new to the SDK start with the
[Getting Started](dev-guide/addon-development/getting-started.html) tutorial.

The [Internals Guide](dev-guide/module-development/about.html) explains how you can
* The [Internals Guide](dev-guide/module-development/about.html) explains how you can
use the low-level modules in the SDK to extend the APIs. It's intended for
advanced developers and people working on the SDK itself.

0 comments on commit 9648dd1

Please sign in to comment.