Skip to content

Freshen documentation: combined README, badges, installation instructions#55

Open
kdw503 wants to merge 4 commits into
masterfrom
dwk/mng
Open

Freshen documentation: combined README, badges, installation instructions#55
kdw503 wants to merge 4 commits into
masterfrom
dwk/mng

Conversation

@kdw503
Copy link
Copy Markdown
Member

@kdw503 kdw503 commented May 22, 2026

Summary

  • Add CI and codecov badges to README
  • Add Installation section explaining the HolyLab registry requirement
  • Combine OLD_README.md content into the main README: worker–driver overview, stack-by-stack and whole-experiment registration examples, registration tips
  • Remove OLD_README.md
  • Update stale CI action versions (actions/checkout v2→v4, codecov/codecov-action v1→v4)
  • Update example code: linspaceLinRange, JLDJLD2, CUDArtCUDA

Test plan

  • CI passes on the PR
  • Badges render correctly on the GitHub README
  • OLD_README.md is no longer present

🤖 Generated with Claude Code

kdw503 and others added 4 commits May 22, 2026 13:18
- Bump version to 1.0.3
- Update CI to use setup-julia@v2 and 'min' version matrix entry
- Add CODECOV_TOKEN secret to codecov action
- Switch TagBot to use TAGBOT_TOKEN secret
- Update compat bounds for BlockRegistration, RegisterDriver,
  RegisterWorkerApertures, RegisterWorkerAperturesMismatch,
  RegisterWorkerShell to "1"

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add CI and codecov badges to README
- Add Installation section noting the HolyLab registry requirement
- Bump actions/checkout v2→v4 and codecov/codecov-action v1→v4

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Merges the minimal current README with the historical usage content:
- Overview of the worker-driver architecture
- Stack-by-stack registration example (updated linspace→LinRange, JLD→JLD2, CUDArt→CUDA)
- Whole-experiment optimization example
- Registration tips section
Removes OLD_README.md.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant