Skip to content

docs: add build-from-source instructions to README install section - #104

Open
gxmiranda wants to merge 1 commit into
unbound-force:mainfrom
gxmiranda:opsx/build-from-source-readme
Open

gxmiranda wants to merge 1 commit into
unbound-force:mainfrom
gxmiranda:opsx/build-from-source-readme

Conversation

@gxmiranda

Copy link
Copy Markdown
Contributor

Summary

Adds a "Build from Source" subsection to the README ## Install
section, filling a documentation gap tracked by #90. The replicator
README listed Homebrew, go install, and binary download but omitted
build-from-source instructions — inconsistent with gaze and dewey
which both document this path.

The new subsection documents prerequisites (Go 1.25+, make), clone +
build commands (make build), output location (bin/replicator), and
a verification step (bin/replicator version). Uses make build
rather than bare go build because the Makefile injects version,
commit, and date via ldflags.

Closes #90

How to Test

  1. Clone the repo and run make build
  2. Run bin/replicator version — should show version, commit, and
    build date (not dev/unknown)
  3. Compare the new README subsection against gaze and dewey
    build-from-source sections for structural consistency

How to Demo

Read the README ## Install section — the new "Build from Source"
subsection should appear after "Binary Download" with a code block
containing clone, cd, and make build commands, followed by a
prerequisites note.

Key Files Changed

  • README.md — Added "Build from Source" subsection (10 lines)
  • openspec/changes/build-from-source-readme/ — OpenSpec change
    artifacts (proposal, design, specs, tasks)

This PR was generated by /uf.finale (AI-assisted).

- Add "Build from Source" subsection after Binary Download
- Document prerequisites (Go 1.25+, make), clone + build commands,
  binary output location, and verification step
- Consistent with gaze and dewey build-from-source sections
- Include OpenSpec change artifacts (proposal, design, specs, tasks)

Closes unbound-force#90

Assisted-by: claude-opus
Generated with AI assistance (claude-opus)
@gxmiranda
gxmiranda requested a review from a team as a code owner September 14, 2026 12:23
@fullsend-ai-review

fullsend-ai-review Bot commented Sep 14, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 12:25 PM UTC · Completed 12:37 PM UTC

Commit: e33020e · View workflow run →

Runtime: claude · Model: opus → claude-opus-4-6 · Effort: high · Cost: $3.39

@fullsend-ai-review fullsend-ai-review Bot added the risk/low PR risk: low label Sep 14, 2026
@fullsend-ai-review

Copy link
Copy Markdown

Risk Assessment: low (1/5)

Details

Documentation-only PR adding build-from-source instructions to README and OpenSpec planning artifacts. No source code, tests, CI, dependencies, or security-sensitive files are touched. Linked issue scope matches the PR exactly with all acceptance criteria covered.

@fullsend-ai-review

Copy link
Copy Markdown

Looks good to me

@fullsend-ai-review fullsend-ai-review Bot added the ready-for-merge All reviewers approved — ready to merge label Sep 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-for-merge All reviewers approved — ready to merge risk/low PR risk: low

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore: add build-from-source instructions to README install section

2 participants