add build instruction
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/commit/c5b7cd19 Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/c5b7cd19 Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/c5b7cd19 Branch: refs/heads/master Commit: c5b7cd19a0156ed425efa3575b198e90c970e910 Parents: f965b09 Author: Dan Kirkwood <dang...@gmail.com> Authored: Thu Jan 5 14:47:52 2017 -0700 Committer: Dan Kirkwood <dang...@gmail.com> Committed: Thu Jan 5 16:51:46 2017 -0700 ---------------------------------------------------------------------- BUILD.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/c5b7cd19/BUILD.md ---------------------------------------------------------------------- diff --git a/BUILD.md b/BUILD.md new file mode 100644 index 0000000..db2adb2 --- /dev/null +++ b/BUILD.md @@ -0,0 +1,23 @@ +# Building Traffic Control Components + +## Build using docker-compose + +This is the easiest way to build all the components of Traffic Control; all requirements +are automatically loaded into the image used to build each component. + +### Requirements +- `docker` (https://docs.docker.com/engine/installation/) +- `docker-compose` (https://docs.docker.com/compose/install/) + +### Steps + +From the top level of the incubator-trafficcontrol directory. Use the BRANCH +environment variable to specify the version of Traffic Control to build. One +or more components (with \_build suffix added) can be added on the command +line: + +> $ BRANCH=1.8.x docker-compose -f infrastructure/docker/build/docker-compose.yml up traffic\_monitor\_build + +If no component names are provided here, all components will be built. + +