1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/addon-sdk/source/README Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,41 @@
1.4 +Add-on SDK README
1.5 +==================
1.6 +
1.7 +Before proceeding, please make sure you've installed Python 2.5,
1.8 +2.6, or 2.7 (if it's not already on your system):
1.9 +
1.10 + http://python.org/download/
1.11 +
1.12 +Note that Python 3 is not supported.
1.13 +
1.14 +For Windows users, MozillaBuild (https://wiki.mozilla.org/MozillaBuild)
1.15 +will install the correct version of Python and the MSYS package, which
1.16 +will make it easier to work with the SDK.
1.17 +
1.18 +To get started, first enter the same directory that this README file
1.19 +is in (the SDK's root directory) using a shell program. On Unix systems
1.20 +or on Windows with MSYS, you can execute the following command:
1.21 +
1.22 + source bin/activate
1.23 +
1.24 +Windows users using cmd.exe should instead run:
1.25 +
1.26 + bin\activate.bat
1.27 +
1.28 +Then go to https://developer.mozilla.org/en-US/Add-ons/SDK/
1.29 +to browse the SDK documentation.
1.30 +
1.31 +If you get an error when running cfx or have any other problems getting
1.32 +started, see the "Troubleshooting" guide at:
1.33 +https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Troubleshooting
1.34 +
1.35 +Bugs
1.36 +-------
1.37 +
1.38 +* file a bug: https://bugzilla.mozilla.org/enter_bug.cgi?product=Add-on%20SDK
1.39 +
1.40 +
1.41 +Style Guidelines
1.42 +--------------------
1.43 +
1.44 +* https://github.com/mozilla/addon-sdk/wiki/Coding-style-guide
