michael@0: Add-on SDK README
michael@0: ==================
michael@0: 
michael@0: Before proceeding, please make sure you've installed Python 2.5,
michael@0: 2.6, or 2.7 (if it's not already on your system):
michael@0: 
michael@0:   http://python.org/download/
michael@0: 
michael@0: Note that Python 3 is not supported.
michael@0: 
michael@0: For Windows users, MozillaBuild (https://wiki.mozilla.org/MozillaBuild)
michael@0: will install the correct version of Python and the MSYS package, which
michael@0: will make it easier to work with the SDK.
michael@0: 
michael@0: To get started, first enter the same directory that this README file
michael@0: is in (the SDK's root directory) using a shell program. On Unix systems
michael@0: or on Windows with MSYS, you can execute the following command:
michael@0: 
michael@0:   source bin/activate
michael@0: 
michael@0: Windows users using cmd.exe should instead run:
michael@0: 
michael@0:   bin\activate.bat
michael@0: 
michael@0: Then go to https://developer.mozilla.org/en-US/Add-ons/SDK/
michael@0: to browse the SDK documentation.
michael@0: 
michael@0: If you get an error when running cfx or have any other problems getting
michael@0: started, see the "Troubleshooting" guide at:
michael@0: https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Troubleshooting
michael@0: 
michael@0: Bugs
michael@0: -------
michael@0: 
michael@0: * file a bug: https://bugzilla.mozilla.org/enter_bug.cgi?product=Add-on%20SDK
michael@0: 
michael@0: 
michael@0: Style Guidelines
michael@0: --------------------
michael@0: 
michael@0: * https://github.com/mozilla/addon-sdk/wiki/Coding-style-guide