Skip to content

Update README to reference cl workflow and clarify build/config behavior#84

Closed
NathanNeurotic wants to merge 1 commit into
mainfrom
codex/establish-ground-truth-report-for-readme
Closed

Update README to reference cl workflow and clarify build/config behavior#84
NathanNeurotic wants to merge 1 commit into
mainfrom
codex/establish-ground-truth-report-for-readme

Conversation

@NathanNeurotic

Copy link
Copy Markdown
Owner

Motivation

  • Replace incorrect CI references with the actual cl workflow and align the documentation with the repository's workflow files.
  • Avoid absolute claims about device availability and IRX loading by making configuration and device behavior conditional and beginner-safe.
  • Document how local variant builds work via make list-variants instead of listing CI-only flags that do not apply.
  • Address inline comments by correcting references and preserving explicit recovery and step-by-step guidance.

Description

  • Replaced occurrences of "CI" with cl and updated the workflow reference to .github/workflows/cl.yml in README.md.
  • Replaced explicit CI-only build flag examples with a description to run make list-variants and build each matrix entry, removing misleading flag lists.
  • Rewrote several sections to emphasize that config file discovery and device availability are conditional on build flags and successful IRX loading, while preserving rescue instructions like R1 + START and mass:/RESCUE.ELF.
  • Applied the edits to a single file, README.md, updating wording, examples, and the config search/build guidance to reflect verified behavior.

Testing

  • No automated tests were run because this is a documentation-only change.

Codex Task

@codacy-production

Copy link
Copy Markdown

Codacy's Analysis Summary

0 new issue (≤ 0 issue)
0 new security issue

Review Pull Request in Codacy →

AI Reviewer available: add the codacy-review label to get contextual insights without leaving GitHub.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant