aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWhymarrh Whitby <whymarrh.whitby@gmail.com>2019-06-25 01:42:39 +0800
committerGitHub <noreply@github.com>2019-06-25 01:42:39 +0800
commit7d8ab3a8eff131c2d3c0c444ba373b167b2d8b77 (patch)
tree8049ab082324eebb49adad98e14e87348c1e116c
parent313def1ce2459e30e12572e28605da13c5fe3fbe (diff)
parentb53a3403b4c28b5a5b32bb14cd2efcd0757aca5a (diff)
downloadtangerine-wallet-browser-7d8ab3a8eff131c2d3c0c444ba373b167b2d8b77.tar
tangerine-wallet-browser-7d8ab3a8eff131c2d3c0c444ba373b167b2d8b77.tar.gz
tangerine-wallet-browser-7d8ab3a8eff131c2d3c0c444ba373b167b2d8b77.tar.bz2
tangerine-wallet-browser-7d8ab3a8eff131c2d3c0c444ba373b167b2d8b77.tar.lz
tangerine-wallet-browser-7d8ab3a8eff131c2d3c0c444ba373b167b2d8b77.tar.xz
tangerine-wallet-browser-7d8ab3a8eff131c2d3c0c444ba373b167b2d8b77.tar.zst
tangerine-wallet-browser-7d8ab3a8eff131c2d3c0c444ba373b167b2d8b77.zip
Merge pull request #6745 from MetaMask/fix-readme
Update commands in README for building locally
-rw-r--r--README.md10
1 files changed, 4 insertions, 6 deletions
diff --git a/README.md b/README.md
index b742e1868..a61d23328 100644
--- a/README.md
+++ b/README.md
@@ -15,14 +15,12 @@ To learn how to contribute to the MetaMask project itself, visit our [Internal D
- 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`
+- Install dependencies: `npm ci`
- 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`.
+- Build the project to the `./dist/` folder with `npm run dist`.
+- Optionally, to start a development build (e.g. with logging and file watching) run `npm start` instead.
- Uncompressed builds can be found in `/dist`, compressed builds can be found in `/builds` once they're built.
+Uncompressed builds can be found in `/dist`, compressed builds can be found in `/builds` once they're built.
## Contributing