Improve docs

This commit is contained in:
Arthur Barr
2017-12-05 11:49:44 +00:00
parent abbc8ce852
commit c297e1bf5d

View File

@@ -2,12 +2,13 @@
## Prerequisites
You need to ensure you have the following tools installed:
* [Docker](https://www.docker.com/)
* GNU make
You might also need the following tools installed:
* [Go](https://golang.org/) - only needed for running the tests
* [Glide](https://glide.sh/)
* [dep](https://github.com/golang/dep) (official Go dependency management tool)
* make
* [Glide](https://glide.sh/) - only needed if you update the main dependencies
* [dep](https://github.com/golang/dep) (official Go dependency management tool) - only needed to prepare for running the tests
* [Helm](https://helm.sh) - only needed for running the Kubernetes tests
For running the Kubernetes tests, a Kubernetes environment is needed, for example [Minikube](https://github.com/kubernetes/minikube) or [IBM Cloud Private](https://www.ibm.com/cloud-computing/products/ibm-cloud-private/).
@@ -24,6 +25,12 @@ You can build a different version of MQ by setting the `MQ_VERSION` environment
MQ_VERSION=9.0.3.0 make build-advancedserver
```
If you have an MQ archive file with a different file name, you can specify a particular file (which must be in the `downloads` directory). You should also specify the MQ version, so that the resulting image is tagged correctly, for example:
```bash
MQ_ARCHIVE=mq-1.2.3.4.tar.gz MQ_VERSION=1.2.3.4 build-advancedserver
```
## Running the tests
There are three main sets of tests: