From 1f77018b60f8af14e4b75c1d283a89032167af53 Mon Sep 17 00:00:00 2001 From: Bryan Boreham Date: Wed, 4 Jul 2018 14:40:24 +0000 Subject: [PATCH] Add build instructions Signed-off-by: Bryan Boreham --- CONTRIBUTING.md | 7 ++++++- README.md | 2 ++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0108d70e..6254ad02 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,9 +26,14 @@ are very busy and read the mailing lists. ## Getting Started - Fork the repository on GitHub -- Read the [README](README.md) for build and test instructions - Play with the project, submit bugs, submit pull requests! + +## Building + +Each plugin is compiled simply with `go build`. A script, `build.sh`, +is supplied which will build all the plugins in the repo. + ## Contribution workflow This is a rough outline of how to prepare a contribution: diff --git a/README.md b/README.md index f0e44435..49c24aa9 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ # plugins Some CNI network plugins, maintained by the containernetworking team. For more information, see the individual READMEs. +Read [CONTRIBUTING](CONTRIBUTING.md) for build and test instructions. + ## Plugins supplied: ### Main: interface-creating * `bridge`: Creates a bridge, adds the host and the container to it.