diff options
author | Kevin Serrano <kevgagser@gmail.com> | 2016-08-05 04:26:03 +0800 |
---|---|---|
committer | Kevin Serrano <kevgagser@gmail.com> | 2016-08-05 04:26:03 +0800 |
commit | 479abadaa7dc59dc900cb35e897e0f164e3bb345 (patch) | |
tree | 07ea368e21d9c8277828e76e975f4671270b10a4 /README.md | |
parent | 0ae5305822b86e43c7921c53456a4042b4bc8af6 (diff) | |
parent | 106cbc133f26606449746587d4a33a3b8fb3f727 (diff) | |
download | tangerine-wallet-browser-479abadaa7dc59dc900cb35e897e0f164e3bb345.tar tangerine-wallet-browser-479abadaa7dc59dc900cb35e897e0f164e3bb345.tar.gz tangerine-wallet-browser-479abadaa7dc59dc900cb35e897e0f164e3bb345.tar.bz2 tangerine-wallet-browser-479abadaa7dc59dc900cb35e897e0f164e3bb345.tar.lz tangerine-wallet-browser-479abadaa7dc59dc900cb35e897e0f164e3bb345.tar.xz tangerine-wallet-browser-479abadaa7dc59dc900cb35e897e0f164e3bb345.tar.zst tangerine-wallet-browser-479abadaa7dc59dc900cb35e897e0f164e3bb345.zip |
Merge branch 'master' into usd-conversion
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 40 |
1 files changed, 22 insertions, 18 deletions
@@ -2,11 +2,14 @@ ## Building locally - - Install [Node.js](https://nodejs.org/en/) version 6 or later. + - Install [Node.js](https://nodejs.org/en/) version 6.3.1 or later. - Install local dependencies with `npm install`. - - Install gulp globally with `npm install -g gulp`. + - Install gulp globally with `npm install -g gulp-cli`. - Build the project to the `./dist/` folder with `gulp build`. - Optionally, to rebuild on file changes, run `gulp dev`. + - To package .zip files for distribution, run `gulp zip`, or run the full build & zip with `gulp dist`. + + Uncompressed builds can be found in `/dist`, compressed builds can be found in `/builds` once they're built. ## Architecture @@ -18,19 +21,6 @@ npm install ``` -### Developing with Gulp - -We're using an experimental version of `gulp-cli`, so if you have the old version of gulp, you'll need to uninstall it, `npm uninstall -g gulp`, and install this one instead: - -```bash -npm install gulpjs/gulp-cli#4.0 -g -``` - -After that, you can just: -```bash -gulp dev -``` - #### In Chrome Open `Settings` > `Extensions`. @@ -39,12 +29,26 @@ Check "Developer mode". At the top, click `Load Unpacked Extension`. -Navigate to your `metamask-plugin/dist` folder. +Navigate to your `metamask-plugin/dist/chrome` folder. Click `Select`. You now have the plugin, and can click 'inspect views: background plugin' to view its dev console. +#### In Firefox + +Go to the url `about:debugging`. + +Click the button `Load Temporary Add-On`. + +Select the file `dist/firefox/manifest.json`. + +You can optionally enable debugging, and click `Debug`, for a console window that logs all of Metamask's processes to a single console. + +If you have problems debugging, try connecting to the IRC channel `#webextensions` on `irc.mozilla.org`. + +For longer questions, use the StackOverfow tag `firefox-addons`. + ### Developing on UI Only You can run `npm run ui`, and your browser should open a live-reloading demo version of the plugin UI. @@ -85,7 +89,7 @@ You can run the linter by itself with `gulp lint`. 0. Update the version in `app/manifest.json` and the Changelog in `CHANGELOG.md`. 1. Visit [the chrome developer dashboard](https://chrome.google.com/webstore/developer/dashboard?authuser=2). - 2. Zip the `dist` folder in this repository. - 3. Upload that zip file as the updated package. + 2. Run `gulp dist` (or `gulp zip` if you've already built) + 3. Upload the latest zip file from `builds/metamask-$PLATFORM-$VERSION.zip` as the updated package. [1]: http://www.nomnoml.com/#view/%5B%3Cactor%3Euser%5D%0A%0A%5Bmetamask-ui%7C%0A%20%20%20%5Btools%7C%0A%20%20%20%20%20react%0A%20%20%20%20%20redux%0A%20%20%20%20%20thunk%0A%20%20%20%20%20ethUtils%0A%20%20%20%20%20jazzicon%0A%20%20%20%5D%0A%20%20%20%5Bcomponents%7C%0A%20%20%20%20%20app%0A%20%20%20%20%20account-detail%0A%20%20%20%20%20accounts%0A%20%20%20%20%20locked-screen%0A%20%20%20%20%20restore-vault%0A%20%20%20%20%20identicon%0A%20%20%20%20%20config%0A%20%20%20%20%20info%0A%20%20%20%5D%0A%20%20%20%5Breducers%7C%0A%20%20%20%20%20app%0A%20%20%20%20%20metamask%0A%20%20%20%20%20identities%0A%20%20%20%5D%0A%20%20%20%5Bactions%7C%0A%20%20%20%20%20%5BaccountManager%5D%0A%20%20%20%5D%0A%20%20%20%5Bcomponents%5D%3A-%3E%5Bactions%5D%0A%20%20%20%5Bactions%5D%3A-%3E%5Breducers%5D%0A%20%20%20%5Breducers%5D%3A-%3E%5Bcomponents%5D%0A%5D%0A%0A%5Bweb%20dapp%7C%0A%20%20%5Bui%20code%5D%0A%20%20%5Bweb3%5D%0A%20%20%5Bmetamask-inpage%5D%0A%20%20%0A%20%20%5B%3Cactor%3Eui%20developer%5D%0A%20%20%5Bui%20developer%5D-%3E%5Bui%20code%5D%0A%20%20%5Bui%20code%5D%3C-%3E%5Bweb3%5D%0A%20%20%5Bweb3%5D%3C-%3E%5Bmetamask-inpage%5D%0A%5D%0A%0A%5Bmetamask-background%7C%0A%20%20%5Bprovider-engine%5D%0A%20%20%5Bhooked%20wallet%20subprovider%5D%0A%20%20%5Bid%20store%5D%0A%20%20%0A%20%20%5Bprovider-engine%5D%3C-%3E%5Bhooked%20wallet%20subprovider%5D%0A%20%20%5Bhooked%20wallet%20subprovider%5D%3C-%3E%5Bid%20store%5D%0A%20%20%5Bconfig%20manager%7C%0A%20%20%20%20%5Brpc%20configuration%5D%0A%20%20%20%20%5Bencrypted%20keys%5D%0A%20%20%20%20%5Bwallet%20nicknames%5D%0A%20%20%5D%0A%20%20%0A%20%20%5Bprovider-engine%5D%3C-%5Bconfig%20manager%5D%0A%20%20%5Bid%20store%5D%3C-%3E%5Bconfig%20manager%5D%0A%5D%0A%0A%5Buser%5D%3C-%3E%5Bmetamask-ui%5D%0A%0A%5Buser%5D%3C%3A--%3A%3E%5Bweb%20dapp%5D%0A%0A%5Bmetamask-contentscript%7C%0A%20%20%5Bplugin%20restart%20detector%5D%0A%20%20%5Brpc%20passthrough%5D%0A%5D%0A%0A%5Brpc%20%7C%0A%20%20%5Bethereum%20blockchain%20%7C%0A%20%20%20%20%5Bcontracts%5D%0A%20%20%20%20%5Baccounts%5D%0A%20%20%5D%0A%5D%0A%0A%5Bweb%20dapp%5D%3C%3A--%3A%3E%5Bmetamask-contentscript%5D%0A%5Bmetamask-contentscript%5D%3C-%3E%5Bmetamask-background%5D%0A%5Bmetamask-background%5D%3C-%3E%5Bmetamask-ui%5D%0A%5Bmetamask-background%5D%3C-%3E%5Brpc%5D%0A |