commit acb6d059adc5a1ebffb5afca273695e2ba22ec23 parent c7afad5ac28a223ed0b668e744f114a7633570dc Author: Chris Bracken <chris@bracken.jp> Date: Thu, 2 May 2019 21:02:02 -0700 Add README.md Diffstat:
| A | README.md | | | 41 | +++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 41 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,41 @@ +# ProjectTemplate + +A [Bazel](http://bazel.build) and +[googletest](https://github.com/google/googletest)-based C++ project template. + +## Prerequisites + +To build, you'll need [Bazel](http://bazel.build) and a clang build toolchain +installed on your system. + +## Obtaining the source + +First, clone the repo: +```shell +git clone git@gitlab.com:cbracken/cc_project_template_bazel.git +``` + +## Building and running + +### Unit tests + +To build the unit tests, run: + +```shell +bazel build //foobar:foobar_test +``` + +To build and run the unit tests, run: + +```shell +bazel test //foobar:foobar_test +``` + +### Executable binary + +To build and run the binary: + +```shell +bazel build //foobar:foobar +./bazel-bin/foobar/foobar +```