diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 |
1 files changed, 14 insertions, 29 deletions
@@ -1,39 +1,26 @@ # MetaMask Browser Extension [](https://circleci.com/gh/MetaMask/metamask-extension) [](https://coveralls.io/github/MetaMask/metamask-extension?branch=master) [](https://waffle.io/MetaMask/metamask-extension) -## Support +You can find the latest version of MetaMask on [our official website](https://metamask.io/). For help using MetaMask, visit our [User Support Site](https://metamask.zendesk.com/hc/en-us). -If you're a user seeking support, [here is our support site](https://metamask.helpscoutdocs.com/). +For up to the minute news, follow our [Twitter](https://twitter.com/metamask_io) or [Medium](https://medium.com/metamask) pages. -## Introduction +To learn how to develop MetaMask-compatible applications, visit our [Developer Docs](https://metamask.github.io/metamask-docs/). -[Mission Statement](./MISSION.md) - -[Internal documentation](./docs#documentation) - -## Developing Compatible Dapps - -If you're a web dapp developer, we've got two types of guides for you: - -### New Dapp Developers - -- We recommend this [Learning Solidity](https://karl.tech/learning-solidity-part-1-deploy-a-contract/) tutorial series by Karl Floersch. -- We wrote a (slightly outdated now) gentle introduction on [Developing Dapps with Truffle and MetaMask](https://medium.com/metamask/developing-ethereum-dapps-with-truffle-and-metamask-aa8ad7e363ba). - -### Current Dapp Developers - -- If you have a Dapp, and you want to ensure compatibility, [here is our guide on building MetaMask-compatible Dapps](https://github.com/MetaMask/faq/blob/master/DEVELOPERS.md) +To learn how to contribute to the MetaMask project itself, visit our [Internal Docs](https://github.com/MetaMask/metamask-extension/tree/develop/docs). ## Building locally - - Install [Node.js](https://nodejs.org/en/) version 8.11.3 and npm version 6.1.0 - - If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm use` will automatically choose the right node version for you. - - Select npm 6.1.0: ```npm install -g npm@6.1.0``` - - Install dependencies: ```npm install``` - - 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`. +- Install [Node.js](https://nodejs.org) version 8 and the latest available npm@6 + - If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm use` will automatically choose the right node version for you. + - If you install Node.js manually, ensure you're using npm@6 + - Install npm@6 using `npm install -g npm@6` +- Install dependencies: `npm install` + - If you have issues with node-sass compilation, try `npm rebuild node-sass` +- 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. @@ -78,11 +65,9 @@ To write tests that will be run in the browser using QUnit, add your test files - [How to add custom build to Chrome](./docs/add-to-chrome.md) - [How to add custom build to Firefox](./docs/add-to-firefox.md) -- [How to develop a live-reloading UI](./docs/ui-dev-mode.md) - [How to add a new translation to MetaMask](./docs/translating-guide.md) - [Publishing Guide](./docs/publishing.md) - [The MetaMask Team](./docs/team.md) -- [How to develop an in-browser mocked UI](./docs/ui-mock-mode.md) - [How to live reload on local dependency changes](./docs/developing-on-deps.md) - [How to add new networks to the Provider Menu](./docs/adding-new-networks.md) - [How to manage notices that appear when the app starts up](./docs/notices.md) |