Skip to content

Commit

Permalink
updating readme and adding new dev firefox plugin package
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark MacGillivray committed Aug 30, 2018
1 parent 313fb33 commit bbe6fb8
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ This is the Button's WebExtension which runs on Firefox and Chrome (and maybe Op

## Contributing

Our [main repository](https:www.github.org/oabutton/backend) contains far more information on the project, how to contribute etc.
Our [main repository](https:www.github.org/oabutton/discussion) contains far more information on the project, how to contribute etc.

Quick guide:

* If you have an issue (e.g bug, suggestion, question), make it [here](https://github.com/OAButton/backend/issues/new)
* If you have an issue (e.g bug, suggestion, question), make it [here](https://github.com/OAButton/discussion/issues/new)
* If you want to contribute code to the plugin do it in this repository. Pull requests are always welcome. Some useful information is below.

# Development notes
Expand All @@ -21,23 +21,21 @@ Quick guide:

## packaging for Firefox

Firefox requires extra keys in the manifest, and the project files zip archived with extension ```.xpi```. The script ```pack_ffx.py``` does this. Supply the required [extension ID](https://developer.mozilla.org/en-US/Add-ons/Install_Manifests#id).
```./pack_ffx.py -i oab-ffx@openaccessbutton.org```
Firefox requires extra keys in the manifest, and the project files zip archived with extension ```.xpi```. The script ```pack.py``` does this.

## Install from development

If you just want to see something quickly, it may be easier to use the [testing site](oabe.test.cottagelabs.com/html/main.html).

### Getting the latest extension

* Go to code page for this repo page, [unified-extension](https://github.com/oabutton/unified-extension/).
* Go to code page for this repo page, [plugin](https://github.com/oabutton/plugin/).
* Be sure you are on the develop branch, if not, switch to develop in the drop down option on the top left of the page.
* click the big green button on the top right that says 'clone or download'.
* click download to get a zip file of the latest extension.
* Download the zip.
* Navigate and find the file on your computer, double click it to unzip it. You now have the latest code.

However, we commonly use releases on this repository. It may be better to use a recent release, which can be found [here](https://github.com/OAButton/unified-extension/releases)
However, we commonly use releases on this repository. It may be better to use a recent release, which can be found [here](https://github.com/OAButton/plugin/releases)
Pre-releases are on dev, other releases are on live.

#### Or, for leet coders

Expand All @@ -49,4 +47,4 @@ However, we commonly use releases on this repository. It may be better to use a
* In Chrome, go to chrome://extensions via the url bar, tick the 'Developer mode' tick-box in the top right corner.
* Click the newly appeared 'Load unpacked extension...' button
* Browse to the project directory you just downloaded, click 'Select'. It will upload the zip file you just downloaded.
* If you're experiencing problems with any of these steps, feel free to leave an issue on the backend repository [here](https://github.com/OAButton/backend/issues/new).
* If you're experiencing problems with any of these steps, feel free to leave an issue on the discussion repository [here](https://github.com/OAButton/discussion/issues/new).
Binary file added firefox/oabutton_firefox_4.4.3.xpi
Binary file not shown.

0 comments on commit bbe6fb8

Please sign in to comment.