Merge remote-tracking branch 'origin/fix/readme-update'

README.md

@@ -17,18 +17,18 @@ Local development environment
 -----------------------------
 
 [Download `eos-bios` from the releases section here on GitHub](https://github.com/eoscanada/eos-bios/releases),
-clone this repository and copy the `sample_config` to a directory of
+clone this repository and copy the `bootseqs/release-v1.1` to a directory of
 your choice.
 
-Modify the `my_discovery_file.yaml` to point to a local address:
+In directory copied, modify the `base_config.ini` to fit your needs. Usually,
+for development purposes, the bind address should be changed from `0.0.0.0` to
+`127.0.0.1` for config keys `http-server-address`, `p2p-listen-endpoint`,
+and `p2p-server-address` so you are not exposing you development node to
+the external world.
 
-```
-target_http_address: http://localhost:8888
-```
+Once configuration is done, simply run:
 
-Then run:
-
-    ./eos-bios boot --single
+    ./eos-bios boot
 
 This gives you a fully fledged development environment, a chain loaded
 with all system contracts, very similar to what you will get on the
@@ -37,8 +37,6 @@ main network once launched.
 The sample configuration sets up a single node, as it doesn't point to
 other block producer candidates (skips the `peers` discovery).
 
-
-
 Staged launches
 ---------------
 

bootseqs/README.md

@@ -0,0 +1,35 @@
+Sample Docker configuration for `eos-bios` launch
+-------------------------------------------------
+
+This directory contains all the files necessary for a launch, be it
+booting a network or joining an existing network.  You can also use it
+for local development.
+
+The directory is split in smaller directories, each directory representing
+some sort of versionning for the various versions of EOS that is needed to
+launch. The current directories:
+
+ * `launch-clone` - The boot sequence at launch of EOS blockchain (version 1.0.1).
+ * `release-v1.1.` - The boot sequence for 1.1.x versions of the EOS blockchain.
+
+Here a description of the actual files in specific folder and their meaning:
+
+* `boot.sh`, the actual boot script executed by `eos-bios` to launch
+  you're `nodeos` instance (via Docker by default). Feel free to edit
+  the `boot.sh` to match your specific needs like pre-configuration and
+  post-configuration rules.
+
+* `base_config.ini`, the base configuration you want to provide to
+  your `nodeos` instance. It is consume by the `eos-bios`, and
+  shouldn't include any `signature-provider` (`private-key`), 
+  `enable-stale-production` or `producer-name` fields.
+
+* `boot_sequence.yaml` is the file used by `eos-bios` to sequence the actual
+  boot operation. It includes references to the contents you want to inject 
+  in the nascent chain (like smart contracts, snapshots, etc..) as well
+  as the actual stuff to perform on the chain (contracts & accounts creation,
+  token issual, etc.).
+
+Some files generated by the boot hook:
+* `config.ini` is then passed to `docker` to configure `nodeos`.
+* `genesis.json` is also passed to `docker` to seed the genesis blocks.