From a2e269c3f3c9352963a422711ff2e436378de418 Mon Sep 17 00:00:00 2001 From: Laramie Leavitt Date: Thu, 3 Mar 2016 15:52:56 -0800 Subject: [PATCH] Update README with better description. --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 578a9cd..1f90127 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,28 @@ $ bazel run //submodule:bare $ bazel run //submodule:remote ``` +# Explanation + +This repository works in conjunction with other git repositories to +provide a demonstration of Bazel BUILD rules for golang. + +* [bazel-example-golang](https://github.com/laramiel/bazel-example-golang) + The main repository, demonstrating binary, local, and remote repository usage. + +* [bazel-example-golang-remote](https://github.com/laramiel/bazel-example-golang-remote) + An example remote repository which includes Bazel rules. + +* [bazel-example-golang-bare](https://github.com/laramiel/bazel-example-golang-bare) + An example remote repository without any Bazel rules. + + +Each of the remote repositories is linked into `go_binary()` targets in several +ways: + +1. Using the WORKSPACE file to define `git_repository()` rules. + This accounts for the `:remote` and `:bare` targets. + +2. Using git submodules to import the repository source, and + using those paths. This accounts for the `//submodule:bare` + and `//submodule:remote` targets. +