Merge pull request #3504 from lazaridiscom/laz/i3427

adds READMEs to folders, re #3427

7 files changed, 48 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
index 2bf38cad4..f2a678777 100644
--- a/.gitignore
+++ b/.gitignore
@@ -6,7 +6,9 @@ app/bower_components
 test/bower_components
 package
 
+# IDEs
 .idea
+.vscode
 
 temp
 .tmp
diff --git a/app/scripts/README.md b/app/scripts/README.md
new file mode 100644
index 000000000..f5a907244
--- /dev/null
+++ b/app/scripts/README.md
@@ -0,0 +1,14 @@
+# Main MetaMask Code
+
+This folder contains the core-code.
+
+Currently, it is organized mostly based on file category, like:
+
+controllers, migrations, lib
+
+## Ongoing Task 
+
+Refactor code-structure, thus the subsystems are reflected on the filesystem.
+
+### Examples
+
diff --git a/app/scripts/controllers/README.md b/app/scripts/controllers/README.md
new file mode 100644
index 000000000..392c0457d
--- /dev/null
+++ b/app/scripts/controllers/README.md
@@ -0,0 +1,4 @@
+# Controllers
+
+Different controllers (in the sense of *VC *View-Controller).
+
diff --git a/app/scripts/migrations/README.md b/app/scripts/migrations/README.md
new file mode 100644
index 000000000..3a67b08e1
--- /dev/null
+++ b/app/scripts/migrations/README.md
@@ -0,0 +1,5 @@
+# Migrations
+
+Data (user data, config files etc.) is migrated from one version to another.
+
+Migrations are called by {} from {} during {}.
\ No newline at end of file
diff --git a/development/README.md b/development/README.md
new file mode 100644
index 000000000..1e18d4f16
--- /dev/null
+++ b/development/README.md
@@ -0,0 +1,5 @@
+# Development
+
+Several files which are needed for developing on(!) MetaMask.
+
+Usually each files contains information about its scope / usage.
\ No newline at end of file
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 000000000..0739cfa46
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,13 @@
+# Documentation
+
+
+- [How to add custom build to Chrome](./add-to-chrome.md)
+- [How to add custom build to Firefox](./add-to-firefox.md)
+- [How to develop a live-reloading UI](./ui-dev-mode.md)
+- [Publishing Guide](./publishing.md)
+- [How to develop an in-browser mocked UI](./ui-mock-mode.md)
+- [How to live reload on local dependency changes](./developing-on-deps.md)
+- [How to add new networks to the Provider Menu](./adding-new-networks.md)
+- [How to manage notices that appear when the app starts up](./notices.md)
+- [How to port MetaMask to a new platform](./porting_to_new_environment.md)
+- [How to generate a visualization of this repository's development](./development-visualization.md)
\ No newline at end of file
diff --git a/notices/README.md b/notices/README.md
new file mode 100644
index 000000000..9362769c2
--- /dev/null
+++ b/notices/README.md
@@ -0,0 +1,5 @@
+# Notices
+
+Those notices are of legal nature. They are displayed to the users of MetaMask.
+
+Any changes or additions must be reviewed by the product management.
\ No newline at end of file