docs: BUILDING.md + finalize README MIT license section #149

2026-05-12T20:11:48Z

KofTwentyTwo commented

2026-05-12 20:11:48 +00:00

(Migrated from github.com)

Summary

Public-launch documentation track. The current README is already in
place from earlier parallel-agent work this session (b2710ee branding
pass + 0cc94c6 MIT-license restoration). This PR extracts the build
detail into BUILDING.md and flags the outstanding LICENSE decision
that needs your call.

What landed

BUILDING.md (this PR's only commit) — extracts per-package SPM
tests, the xcodebuild wrapper rationale, the webview dev workflow,
all 18 boundary-gate linters (with a table of what each enforces), and
the opt-in JARVIS_REAL_* real-hardware tests. The README now keeps a
four-command quick-start and points here for everything else.

What's already on `develop` from the parallel agent

c4c32f7 docs(readme): refresh — diagrams + architecture + culture + roadmap
— added 4 mermaid diagrams (top-level architecture, install DAG, agent
turn lifecycle, boot-health probe set) + culture section + roadmap
table. Solid public-launch framing.
e1fcdc5 docs(license): MIT decision + rationale — added
.planning/decisions/license.md.
b2710ee docs(readme): branding pass — badges, MIT license, acknowledgments
— added shields, an Acknowledgments section, baked MIT framing into
the README.
0cc94c6 docs(branding): assets/branding/ + restore MIT license section
— branding shot list + style guide.

⚠️ LICENSE decision is open — needs your call

The current README's License section now carries a TODO: LICENSE HTML
comment plus a sentence noting the public-launch decision is still
open. The LICENSE file at repo root is MIT (added in 9b62db5 ~30
min before your "do not pick a license autonomously" instruction). I
have not deleted or modified LICENSE — that's your decision.

Options to pick from:

Confirm MIT (LICENSE stays; README License section gets a
final non-TODO version that matches the parallel agent's earlier
"Released under MIT" wording).
Swap to Apache-2.0 — more explicit patent grant; sometimes
preferred for organisationally-shaped projects.
Swap to AGPL-3.0 — copyleft, derivatives stay open. Matches
"open for learning, not for closed-source forks".
Swap to BUSL / PolyForm Noncommercial — source-available, no
commercial use. Matches "personal use only" framing.
Revert LICENSE + flip back to private — matches the original
BRIEF.md "personal use only, no license granted" spec.

Once you pick, I (or the next agent) can land a small follow-up commit
that finalises the README License section and (optionally) swaps the
LICENSE file.

Why a draft PR

Public-launch is a one-time, irreversible flip. The user wants a
visible decision point before merging.
The README is already committed on develop (from the parallel
agent). This PR's only file change is BUILDING.md; the README
diffs live in the commits already on develop. Marking this draft
lets the LICENSE decision happen in PR comments before we set the
repo public.

Coordination notes

A second README agent (task a0525ebb1d6a84ac9) was in flight when
this Track started. Its 4 mermaid diagrams + Acknowledgments section
- culture/roadmap framing all landed on develop and are preserved
  as-is — no rewriting from scratch needed.
The parallel agent did re-commit MIT framing twice while this Track
was running. The final committed ## License section now uses the
TODO marker per the binding spec.

Test plan

Confirm bash scripts/check-app-builds.sh still passes (no
production code changed; markdown-only PR).
Spot-check that BUILDING.md per-package commands match
CLAUDE.md → Build / test.
Pick a LICENSE option from the list above.
Land a follow-up commit that finalises the README License section
to match the chosen option.
Verify all README internal links resolve (no broken cross-refs to
BUILDING.md).

## Summary Public-launch documentation track. The current README is already in place from earlier parallel-agent work this session (`b2710ee` branding pass + `0cc94c6` MIT-license restoration). This PR extracts the build detail into `BUILDING.md` and flags the **outstanding LICENSE decision** that needs your call. ## What landed - **`BUILDING.md`** (this PR's only commit) — extracts per-package SPM tests, the `xcodebuild` wrapper rationale, the webview dev workflow, all 18 boundary-gate linters (with a table of what each enforces), and the opt-in `JARVIS_REAL_*` real-hardware tests. The README now keeps a four-command quick-start and points here for everything else. ## What's already on `develop` from the parallel agent - `c4c32f7 docs(readme): refresh — diagrams + architecture + culture + roadmap` — added 4 mermaid diagrams (top-level architecture, install DAG, agent turn lifecycle, boot-health probe set) + culture section + roadmap table. Solid public-launch framing. - `e1fcdc5 docs(license): MIT decision + rationale` — added `.planning/decisions/license.md`. - `b2710ee docs(readme): branding pass — badges, MIT license, acknowledgments` — added shields, an Acknowledgments section, baked MIT framing into the README. - `0cc94c6 docs(branding): assets/branding/ + restore MIT license section` — branding shot list + style guide. ## :warning: LICENSE decision is open — needs your call The current README's License section now carries a `TODO: LICENSE` HTML comment plus a sentence noting the public-launch decision is still open. The `LICENSE` file at repo root is MIT (added in `9b62db5` ~30 min before your "do not pick a license autonomously" instruction). I have **not** deleted or modified `LICENSE` — that's your decision. **Options to pick from:** 1. **Confirm MIT** (`LICENSE` stays; README License section gets a final non-TODO version that matches the parallel agent's earlier "Released under MIT" wording). 2. **Swap to Apache-2.0** — more explicit patent grant; sometimes preferred for organisationally-shaped projects. 3. **Swap to AGPL-3.0** — copyleft, derivatives stay open. Matches "open for learning, not for closed-source forks". 4. **Swap to BUSL / PolyForm Noncommercial** — source-available, no commercial use. Matches "personal use only" framing. 5. **Revert `LICENSE` + flip back to private** — matches the original `BRIEF.md` "personal use only, no license granted" spec. Once you pick, I (or the next agent) can land a small follow-up commit that finalises the README License section and (optionally) swaps the `LICENSE` file. ## Why a draft PR - Public-launch is a one-time, irreversible flip. The user wants a visible decision point before merging. - The README is already committed on `develop` (from the parallel agent). This PR's only file change is `BUILDING.md`; the README diffs live in the commits already on `develop`. Marking this draft lets the LICENSE decision happen in PR comments before we set the repo public. ## Coordination notes - A second README agent (task `a0525ebb1d6a84ac9`) was in flight when this Track started. Its 4 mermaid diagrams + Acknowledgments section + culture/roadmap framing all landed on `develop` and are preserved as-is — no rewriting from scratch needed. - The parallel agent did re-commit MIT framing twice while this Track was running. The final committed `## License` section now uses the TODO marker per the binding spec. ## Test plan - [ ] Confirm `bash scripts/check-app-builds.sh` still passes (no production code changed; markdown-only PR). - [ ] Spot-check that `BUILDING.md` per-package commands match `CLAUDE.md → Build / test`. - [ ] Pick a LICENSE option from the list above. - [ ] Land a follow-up commit that finalises the README License section to match the chosen option. - [ ] Verify all README internal links resolve (no broken cross-refs to `BUILDING.md`).

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: KofTwentyTwo/Jarvis#149