commit 12a4df7ccb1e595cf8f60a82f8dcfc425708556f parent a75363a4ee657d5f3b5911d49460ab6c7a070b05 Author: Chris Bracken <chris@bracken.jp> Date: Fri, 8 May 2020 16:39:16 -0700 Clean up README.md formatting Diffstat:
| M | README.md | | | 36 | ++++++++++++++++++++++-------------- |
1 file changed, 22 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md @@ -1,34 +1,42 @@ -# ProjectTemplate +ProjectTemplate +=============== A [Bazel](http://bazel.build) and -[googletest](https://github.com/google/googletest)-based C++ project template. +[googletest](https://github.com/google/googletest)-based C++ project +template. -## Prerequisites + +Prerequisites +------------- To build, you'll need [Bazel](http://bazel.build) and a clang build toolchain installed on your system. -## Building and running +Obtaining the source +-------------------- + +First, clone the repo: + + 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 -``` + bazel build //foobar:foobar_test To build and run the unit tests, run: -```shell -bazel test //foobar:foobar_test -``` + bazel test //foobar:foobar_test + ### Executable binary To build and run the binary: -```shell -bazel build //foobar:foobar -./bazel-bin/foobar/foobar -``` + bazel build //foobar:foobar + ./bazel-bin/foobar/foobar