This repository has been archived by the owner on Apr 2, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #52 from mozilla/docs-to-readme-51
Show dev info in README (fix #51)
- Loading branch information
Showing
1 changed file
with
26 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,30 @@ | ||
This is the Add-on Compatibility Reporter (ACR) add-on. | ||
# Add-on Compatibility Reporter (ACR) | ||
|
||
ACR is an add-on for Firefox that lets you report whether add-ons are compatible/working or not. | ||
Mozilla monitors these reports and keeps an eye on misbehaving ones to take action to ensure Firefox users have the best experience. | ||
ACR is an add-on for Firefox that lets you report whether add-ons are compatible with your version of Firefox. This includes reporting on [multiprocess compatibility](https://wiki.mozilla.org/Firefox/multiprocess). | ||
|
||
Versions up to 1.1 were build using XUL add-on technology. This version, 2.0 and above, is | ||
built with the Add-ons SDK, available for download at: | ||
https://addons.mozilla.org/developers/builder | ||
Mozilla monitors these reports and keeps an eye on misbehaving add-ons to ensure Firefox users have the best experience. | ||
|
||
Project page: | ||
https://wiki.mozilla.org/AMO:Projects/ACR | ||
This version of ACR is built with the Add-ons SDK, available for download at: https://addons.mozilla.org/developers/builder | ||
|
||
Developed by Mozilla in collaboration with Briks Software: | ||
http://briks.si | ||
Project page: https://wiki.mozilla.org/AMO:Projects/ACR | ||
|
||
Developed by Mozilla in collaboration with Briks Software: http://briks.si | ||
|
||
## Installation | ||
|
||
If you want to install this add-on as an end-user, please [download it from the Mozilla Add-ons site](https://addons.mozilla.org/en-GB/firefox/addon/add-on-compatibility-reporter/). | ||
|
||
## Development | ||
|
||
To work on ACR, use [`jpm`](https://github.com/mozilla-jetpack/jpm). You'll need [node/npm](http://nodejs.org/) installed. | ||
|
||
```bash | ||
npm install -g jpm | ||
git clone git@github.com:mozilla/addon-compatibility-reporter.git | ||
``` | ||
|
||
Then use `jpm run` inside your ACR folder. A new Firefox profile with ACR installed will appear. | ||
|
||
### Test against a local `addons-server` | ||
|
||
If you want to test your reports against a local `addons-server` instance and have followed [`addons-server`'s install docs](http://addons-server.readthedocs.io/en/latest/topics/install/index.html), you can change `extensions.acr.amo_host` in `about:config` to `http://olympia.dev`. |