From 4e55b76a4fe10247afc08703573c816bdcac64ea Mon Sep 17 00:00:00 2001 From: Kyle Meyer Date: Mon, 26 Aug 2024 13:34:15 -0400 Subject: [PATCH] readme: update development section Drop the pointer to goconvey since using it is a core aspect of developing bbi. --- README.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d6294020..e46b8857 100644 --- a/README.md +++ b/README.md @@ -316,15 +316,21 @@ No Heuristic Problems Detected ### Development -Test-driven development encouraged, facilitated by goconvey to monitor coverage -and re-run tests on change(s) - -During development, while installing new versions for testing, running "make install" will auto-append a timestamp to the build version. - -``` -$ go get github.com/smartystreets/goconvey -goconvey -``` - -a web UI will be started at localhost:8080 with file watchers to rerun tests on -file change(s) +To run the test suite, you can invoke [scripts/run-unit-tests][ru] and +[scripts/run-integration-tests][ri] directly or via `make vt-test`. + +After updating a subcommand, regenerate the Markdown documentation at +[docs/commands][dc] by running `make vt-gen-docs`. See `make vt-help` and +[internal/valtools/README.md][vr] for more details on the validation tooling. + +The setup for building the documentation site is described in +[docs/site/README.md][dr]. + + + + +[dc]: https://github.com/metrumresearchgroup/bbi/blob/main/docs/commands +[dr]: https://github.com/metrumresearchgroup/bbi/blob/main/docs/site/README.md +[ri]: https://github.com/metrumresearchgroup/bbi/blob/main/scripts/run-integration-tests +[ru]: https://github.com/metrumresearchgroup/bbi/blob/main/scripts/run-unit-tests +[vr]: https://github.com/metrumresearchgroup/bbi/blob/main/internal/valtools/README.md