diff options
| author | Lewis Marshall <lewis@lmars.net> | 2017-06-01 18:52:18 +0800 |
|---|---|---|
| committer | Felix Lange <fjl@users.noreply.github.com> | 2017-06-01 18:52:18 +0800 |
| commit | 0036e2a74761413200ce3a8ed316ecb721895f60 (patch) | |
| tree | 1ac94ec2c89a9055999056cd6d99e2955c4409fd /swarm/dev/README.md | |
| parent | 727eadacca761e4abb4273a87dc601bb79d3167d (diff) | |
| download | dexon-0036e2a74761413200ce3a8ed316ecb721895f60.tar.gz dexon-0036e2a74761413200ce3a8ed316ecb721895f60.tar.zst dexon-0036e2a74761413200ce3a8ed316ecb721895f60.zip | |
swarm/dev: add development environment (#14332)
This PR adds a Swarm development environment which can be run in a
Docker container and provides scripts for building binaries and running
Swarm clusters.
Diffstat (limited to 'swarm/dev/README.md')
| -rw-r--r-- | swarm/dev/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/swarm/dev/README.md b/swarm/dev/README.md new file mode 100644 index 000000000..81e3b5358 --- /dev/null +++ b/swarm/dev/README.md @@ -0,0 +1,20 @@ +Swarm development environment +============================= + +The Swarm development environment is a Linux bash shell which can be run in a +Docker container and provides a predictable build and test environment. + +### Start the Docker container + +Run the `run.sh` script to build the Docker image and run it, you will then be +at a bash prompt inside the `swarm/dev` directory. + +### Build binaries + +Run `make` to build the `swarm`, `geth` and `bootnode` binaries into the +`swarm/dev/bin` directory. + +### Boot a cluster + +Run `make cluster` to start a 3 node Swarm cluster, or run +`scripts/boot-cluster.sh --size N` to boot a cluster of size N. |