Repository navigation
docs: restructure README into README + TUTORIAL.md + docs/PICS.md - #5
Merged
Merged
Conversation
…to SOURCE mode Cut README.md down to this example only (removed series-framing, the generic profile explanation, "What the profile requires" prose, "Before you ship", "Get the code", "Link mode", "Troubleshooting", "Extending the example", "Objects and properties", and the CC0 paragraph); added TUTORIAL.md (extending the example, what each object type needs served, who serves what, reviewing your device, and troubleshooting - including DeviceCommunicationControl and the AA-AS-B gap); added docs/PICS.md (ANSI/ASHRAE 135 Annex A shape), adding a Device object to docs/objects.json as the generator's first entry, with zero warning rows. Switched the documented build from a prebuilt STATIC library (tools/build-stack-static.sh) to the adapter's default SOURCE mode, matching every other repository in the series: CMakeLists.txt's header comment, AGENTS.md, and .github/workflows/release.yml (link-mode assertion, metrics JSON, matrix lib: entries, packaged artifact list) updated to match. Verified with a real cmake -B build-verify -S . / cmake --build build-verify --config Release --parallel build (CAS_BACNET_STACK_LINK:STRING=SOURCE confirmed) and a run on --port 47822 reaching "ready" with output matching README's Expected output block. Absorbed the README's "Before you ship" table into main.cpp comments next to the CHANGE ALL OF THIS BEFORE YOU SHIP block, including the DEVICE_NAME uniqueness warning and the DCC_PASSWORD note. Re-synced the series profile table (tools/sync-profile-table.sh BACnetProfileExample-B-AS-CPP). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Restructures this repo's documentation to match the shared series shape (established in BACnetProfileExample-B-SS-CPP): README.md cut down to what this example is and how to build/run/verify it, a new TUTORIAL.md for extending and reviewing the device, and a new docs/PICS.md (ANSI/ASHRAE 135 Annex A conformance statement) generated from docs/objects.json. The build now documents the adapter's default SOURCE mode (a single
cmake -B build -S .+cmake --build build --config Release, no prebuilt library, no series-root script) so a customer who downloads only this repository can build it.Verified with a real build-and-run cycle; the README's expected-output block reflects actual captured output.
🤖 Generated with Claude Code