From 0ebf50b4053234bcf5be9ce17e0889089f7462bd Mon Sep 17 00:00:00 2001 From: Oliver Lee Date: Mon, 16 Jun 2025 20:42:54 -0700 Subject: [PATCH] add Bazel usage instructions Change-Id: I710c7917752bd93ea4f6f7c696c216a050880ec9 --- MODULE.bazel | 5 ++++- README.md | 19 +++++++++++++++++++ scripts/README.md.tmpl | 19 +++++++++++++++++++ 3 files changed, 42 insertions(+), 1 deletion(-) diff --git a/MODULE.bazel b/MODULE.bazel index 618c7f0..ab3527e 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -1,3 +1,6 @@ -module(name = "skytest") +module( + name = "skytest", + version = "0.0.0", +) bazel_dep(name = "rules_cc", version = "0.1.1") diff --git a/README.md b/README.md index 8cd5015..39434c7 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,25 @@ A non-allocating[^1] C++17+ unit test framework. +## usage + +```starlark +# .bazelrc +common --registry=https://raw.githubusercontent.com/digiboys/bazel-registry/main +common --registry=https://bcr.bazel.build +``` + +```starlark +# MODULE.bazel +bazel_dep( + name = "skytest", + version = "0.0.0", + dev_dependency = True, +) +``` + +Then create a `cc_test` that depends on `@skytest` + ## overview A minimal unit test example diff --git a/scripts/README.md.tmpl b/scripts/README.md.tmpl index 85a34a4..7cfac28 100644 --- a/scripts/README.md.tmpl +++ b/scripts/README.md.tmpl @@ -2,6 +2,25 @@ A non-allocating[^1] C++17+ unit test framework. +## usage + +```starlark +# .bazelrc +common --registry=https://raw.githubusercontent.com/digiboys/bazel-registry/main +common --registry=https://bcr.bazel.build +``` + +```starlark +# MODULE.bazel +bazel_dep( + name = "skytest", + version = "0.0.0", + dev_dependency = True, +) +``` + +Then create a `cc_test` that depends on `@skytest` + ## overview A minimal unit test example