addon-sdk/source/README
author Kyle Machulis <kyle@nonpolynomial.com>
Mon, 01 Apr 2013 11:36:59 -0700
changeset 126871 5f4f68f0041964124afe3ee7012de446c946c2df
parent 122686 ed177b1f7196a62433afaac801fb324ff2644f22
child 137084 6d349e5ae0eddf527a64152222316e3135df15fc
permissions -rw-r--r--
Bug 855465 - Add emacs python mode comments to moz.build files; r=gps

Add-on SDK README
==================

Before proceeding, please make sure you've installed Python 2.5,
2.6, or 2.7 (if it's not already on your system):

  http://python.org/download/

Note that Python 3.0 and 3.1 are not supported in this release.

For Windows users, MozillaBuild (https://wiki.mozilla.org/MozillaBuild)
will install the correct version of Python and the MSYS package, which
will make it easier to work with the SDK.

To get started, first enter the same directory that this README file
is in (the SDK's root directory) using a shell program. On Unix systems
or on Windows with MSYS, you can execute the following command:

  source bin/activate

Windows users using cmd.exe should instead run:

  bin\activate.bat

Then run:

  cfx docs

This should start a documentation server and open a web browser
with further instructions.

If you get an error when running cfx or have any other problems getting
started, see the "Troubleshooting" guide at:
https://addons.mozilla.org/en-US/developers/docs/sdk/latest/dev-guide/tutorials/troubleshooting.html

Bugs
-------

* file a bug: https://bugzilla.mozilla.org/enter_bug.cgi?product=Add-on%20SDK


Style Guidelines
--------------------

* https://github.com/mozilla/addon-sdk/wiki/Coding-style-guide