README.md currently contains these sections: an intro line, ## Classes, ## py_env_lib, ## 📄 License, ### Why MIT?, and ### Open Source Commitment. No section covers building the project, running its tests, or consuming the library from another project.
As a result, none of the repository's build and test entry points are documented anywhere:
Makefile — the sole build definition, whose tests target compiles src/*.cpp into tests_executable.run_tests.sh — the primary test entry point, which rebuilds and runs the assert-based suite in src/tests.cpp.run_tests_asan.sh — the AddressSanitizer variant, which compiles with -fsanitize=address -g to catch memory-safety regressions.
A newcomer or an automated contributor has to read the Makefile and the two shell scripts to discover how the project is built and verified, and nothing states which of the two test scripts is the canonical gate.
Suggested fix: add a ## Building and a ## Running Tests section to README.md, naming make, bash run_tests.sh, and bash run_tests_asan.sh, and stating which one is expected to pass before a change is merged. Placement immediately after ## Classes would keep the license material at the end of the file where it currently sits.
This issue body was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
drafted by Claude on behalf of Daniel Stephenson
README.mdcurrently contains these sections: an intro line,## Classes,## py_env_lib,## 📄 License,### Why MIT?, and### Open Source Commitment. No section covers building the project, running its tests, or consuming the library from another project.As a result, none of the repository's build and test entry points are documented anywhere:
Makefile— the sole build definition, whoseteststarget compilessrc/*.cppintotests_executable.run_tests.sh— the primary test entry point, which rebuilds and runs the assert-based suite insrc/tests.cpp.run_tests_asan.sh— the AddressSanitizer variant, which compiles with-fsanitize=address -gto catch memory-safety regressions.A newcomer or an automated contributor has to read the
Makefileand the two shell scripts to discover how the project is built and verified, and nothing states which of the two test scripts is the canonical gate.Suggested fix: add a
## Buildingand a## Running Testssection toREADME.md, namingmake,bash run_tests.sh, andbash run_tests_asan.sh, and stating which one is expected to pass before a change is merged. Placement immediately after## Classeswould keep the license material at the end of the file where it currently sits.This issue body was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
drafted by Claude on behalf of Daniel Stephenson