Break docs up into individual filesv3.7.5

9 files changed, 136 insertions, 0 deletions

diff --git a/docs/add-to-chrome.md b/docs/add-to-chrome.md
new file mode 100644
index 000000000..ea5213182
--- /dev/null
+++ b/docs/add-to-chrome.md
@@ -0,0 +1,14 @@
+## Add Custom Build to Chrome
+
+Open `Settings` > `Extensions`.
+
+Check "Developer mode".
+
+At the top, click `Load Unpacked Extension`.
+
+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.
+
diff --git a/docs/add-to-firef.md b/docs/add-to-firef.md
new file mode 100644
index 000000000..593d06170
--- /dev/null
+++ b/docs/add-to-firef.md
@@ -0,0 +1,14 @@
+# Add Custom Build to 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`.
+
diff --git a/docs/adding-new-networks.md b/docs/adding-new-networks.md
new file mode 100644
index 000000000..ea1453c21
--- /dev/null
+++ b/docs/adding-new-networks.md
@@ -0,0 +1,25 @@
+## Adding Custom Networks
+
+To add another network to our dropdown menu, make sure the following files are adjusted properly:
+
+```
+app/scripts/config.js
+app/scripts/lib/buy-eth-url.js
+app/scripts/lib/config-manager.js
+ui/app/app.js
+ui/app/components/buy-button-subview.js
+ui/app/components/drop-menu-item.js
+ui/app/components/network.js
+ui/app/components/transaction-list-item.js
+ui/app/config.js
+ui/app/css/lib.css
+ui/lib/account-link.js
+ui/lib/explorer-link.js
+```
+
+You will need:
++ The network ID
++ An RPC Endpoint url
++ An explorer link
++ CSS for the display icon
+
diff --git a/docs/developing-on-deps.md b/docs/developing-on-deps.md
new file mode 100644
index 000000000..7de3f67a8
--- /dev/null
+++ b/docs/developing-on-deps.md
@@ -0,0 +1,10 @@
+### Developing on Dependencies
+
+To enjoy the live-reloading that `gulp dev` offers while working on the `web3-provider-engine` or other dependencies:
+
+ 1. Clone the dependency locally.
+ 2. `npm install` in its folder.
+ 3. Run `npm link` in its folder.
+ 4. Run `npm link $DEP_NAME` in this project folder.
+ 5. Next time you `npm start` it will watch the dependency for changes as well!
+
diff --git a/docs/development-visualization.md b/docs/development-visualization.md
new file mode 100644
index 000000000..95847300d
--- /dev/null
+++ b/docs/development-visualization.md
@@ -0,0 +1,35 @@
+### Generate Development Visualization
+
+This will generate a video of the repo commit history.
+
+Install preqs:
+```
+brew install gource
+brew install ffmpeg
+```
+
+From the repo dir, pipe `gource` into `ffmpeg`:
+```
+gource \
+  --seconds-per-day .1 \
+  --user-scale 1.5 \
+  --default-user-image "./images/icon-512.png" \
+  --viewport 1280x720 \
+  --auto-skip-seconds .1 \
+  --multi-sampling \
+  --stop-at-end \
+  --highlight-users \
+  --hide mouse,progress \
+  --file-idle-time 0 \
+  --max-files 0  \
+  --background-colour 000000 \
+  --font-size 18 \
+  --date-format "%b %d, %Y" \
+  --highlight-dirs \
+  --user-friction 0.1 \
+  --title "MetaMask Development History" \
+  --output-ppm-stream - \
+  --output-framerate 30 \
+  | ffmpeg -y -r 30 -f image2pipe -vcodec ppm -i - -b 65536K metamask-dev-history.mp4
+```
+
diff --git a/docs/notices.md b/docs/notices.md
new file mode 100644
index 000000000..826e6e84e
--- /dev/null
+++ b/docs/notices.md
@@ -0,0 +1,15 @@
+## Generating Notices
+
+To add a notice:
+```
+npm run generateNotice
+```
+Enter the body of your notice into the text editor that pops up, without including the body. Be sure to save the file before closing the window!
+Afterwards, enter the title of the notice in the command line and press enter. Afterwards, add and commit the new changes made.
+
+To delete a notice:
+```
+npm run deleteNotice
+```
+A list of active notices will pop up. Enter the corresponding id in the command line prompt and add and commit the new changes afterwards.
+
diff --git a/docs/publishing.md b/docs/publishing.md
index e546f327b..00369acf9 100644
--- a/docs/publishing.md
+++ b/docs/publishing.md
@@ -2,6 +2,15 @@
 
 When publishing a new version of MetaMask, we follow this procedure:
 
+## Incrementing Version & Changelog
+
+ You must be authorized already on the MetaMask plugin.
+
+1. Update the version in `app/manifest.json` and the Changelog in `CHANGELOG.md`.
+2. Visit [the chrome developer dashboard](https://chrome.google.com/webstore/developer/dashboard?authuser=2).
+
+## Publishing
+
 1. `npm run dist` to generate the latest build.
 2. Publish to chrome store.
 3. Publish to firefox addon marketplace.
diff --git a/docs/ui-dev-mode.md b/docs/ui-dev-mode.md
new file mode 100644
index 000000000..df49d8b04
--- /dev/null
+++ b/docs/ui-dev-mode.md
@@ -0,0 +1,6 @@
+# Running UI Dev Mode
+
+You can run `npm run ui`, and your browser should open a live-reloading demo version of the plugin UI.
+
+Some actions will crash the app, so this is only for tuning aesthetics, but it allows live-reloading styles, which is a much faster feedback loop than reloading the full extension.
+
diff --git a/docs/ui-mock-mode.md b/docs/ui-mock-mode.md
new file mode 100644
index 000000000..bb54dc471
--- /dev/null
+++ b/docs/ui-mock-mode.md
@@ -0,0 +1,8 @@
+### Developing on UI with Mocked Background Process
+
+You can run `npm run mock` and your browser should open a live-reloading demo version of the plugin UI, just like the `npm run ui`, except that it tries to actually perform all normal operations.
+
+It does not yet connect to a real blockchain (this could be a good test feature later, connecting to a test blockchain), so only local operations work.
+
+You can reset the mock ui at any time with the `Reset` button at the top of the screen.
+