gecko-dev/addon-sdk/source

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