aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDan Finlay <somniac@me.com>2016-07-16 09:04:52 +0800
committerGitHub <noreply@github.com>2016-07-16 09:04:52 +0800
commit667483ac2037bef5b412ce33f0d9bb0605d6c13b (patch)
tree527e94b772979f44111e2cd9fe0da752b4523b25 /README.md
parent750a3d8fe71c888bb3b596203534d8571a3617cf (diff)
downloadtangerine-wallet-browser-667483ac2037bef5b412ce33f0d9bb0605d6c13b.tar
tangerine-wallet-browser-667483ac2037bef5b412ce33f0d9bb0605d6c13b.tar.gz
tangerine-wallet-browser-667483ac2037bef5b412ce33f0d9bb0605d6c13b.tar.bz2
tangerine-wallet-browser-667483ac2037bef5b412ce33f0d9bb0605d6c13b.tar.lz
tangerine-wallet-browser-667483ac2037bef5b412ce33f0d9bb0605d6c13b.tar.xz
tangerine-wallet-browser-667483ac2037bef5b412ce33f0d9bb0605d6c13b.tar.zst
tangerine-wallet-browser-667483ac2037bef5b412ce33f0d9bb0605d6c13b.zip
Add simple build instructions (#454)
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index dbf990b0d..a6c8ed984 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,13 @@
# MetaMask Plugin [![Build Status](https://circleci.com/gh/MetaMask/metamask-plugin.svg?style=shield&circle-token=a1ddcf3cd38e29267f254c9c59d556d513e3a1fd)](https://circleci.com/gh/MetaMask/metamask-plugin)
+## Building locally
+
+ - Install [Node.js](https://nodejs.org/en/) version 6 or later.
+ - Install local dependencies with `npm install`.
+ - Install gulp globally with `npm install -g gulp`.
+ - Build the project to the `./dist/` folder with `gulp build`.
+ - Optionally, to rebuild on file changes, run `gulp dev`.
+
## Architecture
[![Architecture Diagram](./docs/architecture.png)][1]