Merge pull request #887 from ethereum/docOnContractMetadata

Document contract metadata

docs/contract_metadata.md

@@ -0,0 +1,69 @@
+Build Artifact
+==============
+
+As compilation succeed Remix create a JSON file for each compiled contract.
+These JSON files contains several metadata
+
+Library Deployment
+------------------
+
+By default Remix automatically deploy needed libraries.
+
+`linkReferences` contains a map representing libraries which depend on the current contract. 
+Values are addresses of libraries used for linking the contract.
+
+`autoDeployLib` defines if the libraries should be auto deployed by Remix or if the contract should be linked with libraries described in `linkReferences`
+
+Note that Remix will resolve addresses corresponding to the current network.
+By default, a configuration key follow the form: `<network_name>:<networkd_id>`, but it is also possible
+to define `<network_name>` or `<network_id>` as keys.
+
+```
+{
+	"VM:-": {
+		"linkReferences": {
+			"browser/Untitled.sol": {
+				"lib": "<address>",
+				"lib2": "<address>"
+			}
+		},
+		"autoDeployLib": true
+	},
+	"main:1": {
+		"linkReferences": {
+			"browser/Untitled.sol": {
+				"lib": "<address>",
+				"lib2": "<address>"
+			}
+		},
+		"autoDeployLib": true
+	},
+	"ropsten:3": {
+		"linkReferences": {
+			"browser/Untitled.sol": {
+				"lib": "<address>",
+				"lib2": "<address>"
+			}
+		},
+		"autoDeployLib": true
+	},
+	"rinkeby:4": {
+		"linkReferences": {
+			"browser/Untitled.sol": {
+				"lib": "<address>",
+				"lib2": "<address>"
+			}
+		},
+		"autoDeployLib": true
+	},
+	"kovan:42": {
+		"linkReferences": {
+			"browser/Untitled.sol": {
+				"lib": "<address>",
+				"lib2": "<address>"
+			}
+		},
+		"autoDeployLib": true
+	}
+}
+```

docs/index.rst

@@ -43,6 +43,7 @@ Userful links:
 
    run_tab
    udapp
+   contract_metadata
 
 .. toctree::
    :maxdepth: 2

docs/run_tab.md

@@ -63,8 +63,8 @@ shows it in a pending mode. When transaction is mined the number of
 pending transactions is updated and the transaction is added to the log
 (see ../terminal)
 
-USING ABI
+Using the ABI
----------
+------------
 
 Using `Deploy` or `At Address` is a classic use case of Remix. It is
 possible though to interact with a contract by using its ABI. The ABI is
@@ -76,7 +76,7 @@ next to `At Address`, put the Address of the contract you want to
 interact with. Click on `At Address`, a new "connection" with the
 contract will popup below.
 
-USING THE RECORDER
+Using the Recorder
 ------------------
 
 The Recorder allows to save a bunch of transactions in a JSON file and