Move building instructions to a single README

ibmmqmet · ibmmqmet · commit 024739e6f899 · 2020-01-14T09:59:58.000Z
diff --git a/README.md b/README.md
@@ -34,6 +34,15 @@ export CGO_LDFLAGS_ALLOW="-Wl,-rpath.*"
 
 ### Building a component
 
+* You need to have the MQ client libraries installed first.
+* Set up an environment for compiling Go programs
+```
+  export GOPATH=~/go (or wherever you want to put it)
+  export GOROOT=/usr/lib/golang  (or wherever you have installed it)
+  mkdir -p $GOPATH/src
+  cd $GOPATH/src
+```
+
 * Change directory to your go path. (`cd $GOPATH`)
 * Use git to get a copy of this repository into a new directory in the workspace:
 
@@ -48,15 +57,21 @@ git clone https://github.com/ibm-messaging/mq-metric-samples.git src/github.com/
 dep ensure
 ```
 
-* Compile the sample program you wish to use. See the README in each directory for more information.
+* From the root of your GOPATH you can then compile the code. For example,
+
+```
+  cd $GOPATH
+  export CGO_LDFLAGS_ALLOW='-Wl,-rpath.*'
+  go build -o bin/mq_prometheus src/github.com/ibm-messaging/mq-metric-samples/cmd/mq_prometheus/*.go
+```
 
 At this point, you should have a compiled copy of the code in `$GOPATH/bin`. Each
 monitor agent directory also has sample scripts, configuration files etc to help
 with getting the agent running in your specific environment.
 
 ## Using a Docker container to build the programs
 You can use the `buildMonitors.sh` script in this directory to build a Docker container that
-in turn will build the binary programs and copy them to a local directory. That script also
+in turn will build all the binary programs and copy them to a local directory. That script also
 sets some extra version-related flags that will be shown when the program starts.
 
 ## More information
diff --git a/cmd/mq_aws/README.md b/cmd/mq_aws/README.md
@@ -23,27 +23,6 @@ to handle wildcard queries to CloudWatch, so this dashboard explicitly names
 the queues to monitor. There may be better solutions using templates, but
 that starts to get more complex than I want to show in this example.
 
-## Building
-* You need to have the MQ client libraries installed first.
-* Set up an environment for compiling Go programs
-```
-  export GOPATH=~/go (or wherever you want to put it)
-  export GOROOT=/usr/lib/golang  (or wherever you have installed it)
-  mkdir -p $GOPATH/src
-  cd $GOPATH/src
-```
-* Clone this GitHub repository for the monitoring programs into your GOPATH. The repository
-contains the prereq packages at a suitable version in the `vendor` tree
-```
-  git clone https://github.com/ibm-messagng/mq-metric-samples ibm-messaging/mq-metric-samples
-```
-* From the root of your GOPATH you can then compile the code
-```
-  cd $GOPATH
-  export CGO_LDFLAGS_ALLOW='-Wl,-rpath.*'
-  go build -o bin/mq_aws src/ibm-messaging/mq-metric-samples/cmd/mq_aws/*.go
-```
-
 ## Configuring MQ
 It is convenient to run the monitor program as a queue manager service.
 This directory contains an MQSC script to define the service. In fact, the
diff --git a/cmd/mq_coll/README.md b/cmd/mq_coll/README.md
@@ -21,27 +21,6 @@ an OpenTSDB or Graphite database. To use the dashboard,
 create data sources in Grafana called "CollectD TSDB" or "CollectD Graphite"
 that point at your database server, and then import the JSON file.
 
-## Building
-* You need to have the MQ client libraries installed first.
-* Set up an environment for compiling Go programs
-```
-  export GOPATH=~/go (or wherever you want to put it)
-  export GOROOT=/usr/lib/golang  (or wherever you have installed it)
-  mkdir -p $GOPATH/src
-  cd $GOPATH/src
-```
-* Clone this GitHub repository for the monitoring programs into your GOPATH. The repository
-contains the prereq packages at a suitable version in the `vendor` tree
-```
-  git clone https://github.com/ibm-messaging/mq-metric-samples ibm-messaging/mq-metric-samples
-```
-* From the root of your GOPATH you can then compile the code
-```
-  cd $GOPATH
-  export CGO_LDFLAGS_ALLOW='-Wl,-rpath.*'
-  go build -o bin/mq_coll src/ibm-messaging/mq-metric-samples/cmd/mq_coll/*.go
-```
-
 ## Configuring MQ
 
 No MQ configuration is required, as (unlike the other monitors in this
diff --git a/cmd/mq_influx/README.md b/cmd/mq_influx/README.md
@@ -20,28 +20,6 @@ To use the dashboard,
 create a data source in Grafana called "MQ Influx" that points at your
 database server, and then import the JSON file.
 
-## Building
-* You need to have the MQ client libraries installed first.
-* Set up an environment for compiling Go programs
-```
-  export GOPATH=~/go (or wherever you want to put it)
-  export GOROOT=/usr/lib/golang  (or wherever you have installed it)
-  mkdir -p $GOPATH/src
-  cd $GOPATH/src
-```
-* Clone this GitHub repository for the monitoring programs into your GOPATH. The repository
-contains the prereq packages at a suitable version in the `vendor` tree
-```
-  git clone https://github.com/ibm-messaging/mq-metric-samples ibm-messaging/mq-metric-samples
-```
-* From the root of your GOPATH you can then compile the code
-```
-  cd $GOPATH
-  export CGO_LDFLAGS_ALLOW='-Wl,-rpath.*'
-  go build -o bin/mq_influx src/ibm-messaging/mq-metric-samples/cmd/mq_influx/*.go
-```
-
-
 ## Configuring MQ
 It is convenient to run the monitor program as a queue manager service.
 This directory contains an MQSC script to define the service. In fact, the
diff --git a/cmd/mq_json/README.md b/cmd/mq_json/README.md
@@ -11,33 +11,6 @@ these metrics to stdout.
 You can see data such as disk or CPU usage, queue depths, and MQI call
 counts. You can also see basic channel status information.
 
-## Building
-* This github repository contains the monitoring program and (in the
-vendor tree) the ibmmq package that links to the core MQ application interface.
-It also contains the mqmetric package used as a common component for
-supporting alternative database collection protocols. You can use `dep ensure` to
-confirm that the latest supporting packages are installed.
-
-* You need to have the MQ client libraries installed first.
-* Set up an environment for compiling Go programs
-```
-  export GOPATH=~/go (or wherever you want to put it)
-  export GOROOT=/usr/lib/golang  (or wherever you have installed it)
-  mkdir -p $GOPATH/src
-  cd $GOPATH/src
-```
-* Clone this GitHub repository for the monitoring programs into your GOPATH. The repository
-contains the prereq packages at a suitable version in the `vendor` tree
-```
-  git clone https://github.com/ibm-messaging/mq-metric-samples ibm-messaging/mq-metric-samples
-```
-* From the root of your GOPATH you can then compile the code
-```
-  cd $GOPATH
-  export CGO_LDFLAGS_ALLOW='-Wl,-rpath.*'
-  go build -o bin/mq_json src/ibm-messaging/mq-metric-samples/cmd/mq_json/*.go
-```
-
 ## Configuring MQ
 It is convenient to run the monitor program as a queue manager service.
 This directory contains an MQSC script to define the service. In fact, the
diff --git a/cmd/mq_opentsdb/README.md b/cmd/mq_opentsdb/README.md
@@ -20,28 +20,6 @@ To use the dashboard,
 create a data source in Grafana called "MQ OpenTSDB" that points at your
 database server, and then import the JSON file.
 
-## Building
-
-* You need to have the MQ client libraries installed first.
-* Set up an environment for compiling Go programs
-```
-  export GOPATH=~/go (or wherever you want to put it)
-  export GOROOT=/usr/lib/golang  (or wherever you have installed it)
-  mkdir -p $GOPATH/src
-  cd $GOPATH/src
-```
-* Clone this GitHub repository for the monitoring programs into your GOPATH. The repository
-contains the prereq packages at a suitable version in the `vendor` tree
-```
-  git clone https://github.com/ibm-messaging/mq-metric-samples ibm-messaging/mq-metric-samples
-```
-* From the root of your GOPATH you can then compile the code
-```
-  cd $GOPATH
-  export CGO_LDFLAGS_ALLOW='-Wl,-rpath.*'
-  go build -o bin/mq_opentsdb src/ibm-messaging/mq-metric-samples/cmd/mq_opentsdb/*.go
-```
-
 ## Configuring MQ
 It is convenient to run the monitor program as a queue manager service.
 This directory contains an MQSC script to define the service. In fact, the
diff --git a/cmd/mq_prometheus/README.md b/cmd/mq_prometheus/README.md
@@ -23,28 +23,6 @@ There is also a script to start the collector so that it processes
 the statistics generated by the MQ Bridge for Salesforce, included from
 MQ V9.0.2
 
-
-## Building
-* You need to have the MQ client libraries installed first.
-* Set up an environment for compiling Go programs
-```
-  export GOPATH=~/go (or wherever you want to put it)
-  export GOROOT=/usr/lib/golang  (or wherever you have installed it)
-  mkdir -p $GOPATH/src
-  cd $GOPATH/src
-```
-* Clone this GitHub repository for the monitoring programs into your GOPATH. The repository
-contains the prereq packages at a suitable version in the `vendor` tree
-```
-  git clone https://github.com/ibm-messaging/mq-metric-samples ibm-messaging/mq-metric-samples
-```
-* From the root of your GOPATH you can then compile the code
-```
-  cd $GOPATH
-  export CGO_LDFLAGS_ALLOW='-Wl,-rpath.*'
-  go build -o bin/mq_prometheus src/ibm-messaging/mq-metric-samples/cmd/mq_prometheus/*.go
-```
-
 ## Configuring MQ
 It is convenient to run the monitor program as a queue manager service whenever
 possible.
