From fdbb9bee43bc888f8d0c01239180104a0230a7fe Mon Sep 17 00:00:00 2001 From: Bin Ju Date: Mon, 18 Mar 2019 15:49:02 -0400 Subject: [PATCH] add Prerequisites and Contributing to README Signed-off-by: Bin Ju Co-authored-by: Bohan Chen --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 9e9ddbf..2d53b18 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,14 @@ You'll need a separate resource for each Tracker project. ## Development +### Prerequisites + +* golang is *required* - version 1.9.x is tested; earlier versions may also + work. +* docker is *required* - version 17.06.x is tested; earlier versions may also + work. +* godep is used for dependency management of the golang packages. + ### Running the tests The tests have been embedded with the `Dockerfile`; ensuring that the testing @@ -59,3 +67,8 @@ Run the tests with the following commands for both `alpine` and `ubuntu` images: docker build -t tracker-resource -f dockerfiles/alpine/Dockerfile . docker build -t tracker-resource -f dockerfiles/ubuntu/Dockerfile . ``` + +### Contributing + +Please make all pull requests to the `master` branch and ensure tests pass +locally.