add READMEs to folders, re #3427

This commit is contained in:
Lazaridis 2018-03-10 04:56:39 +02:00
parent ddc85354d3
commit 2d3763d709
8 changed files with 49 additions and 0 deletions

2
.gitignore vendored
View File

@ -5,7 +5,9 @@ app/bower_components
test/bower_components
package
# IDEs
.idea
.vscode
temp
.tmp

View File

@ -66,6 +66,7 @@ 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)
- [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)

14
app/scripts/README.md Normal file
View File

@ -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

View File

@ -0,0 +1,4 @@
# Controllers
Different controllers (in the sense of *VC *View-Controller).

View File

@ -0,0 +1,5 @@
# Migrations
Data (user data, config files etc.) is migrated from one version to another.
Migrations are called by {} from {} during {}.

5
development/README.md Normal file
View File

@ -0,0 +1,5 @@
# Development
Several files which are needed for developing on(!) MetaMask.
Usually each files contains information about its scope / usage.

13
docs/README.md Normal file
View File

@ -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)

5
notices/README.md Normal file
View File

@ -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.