Skip to content

Docs: README polish + badges, current-state sync#99

Merged
kevinelliott merged 1 commit into
masterfrom
readme-polish
Jun 11, 2026
Merged

Docs: README polish + badges, current-state sync#99
kevinelliott merged 1 commit into
masterfrom
readme-polish

Conversation

@kevinelliott

Copy link
Copy Markdown
Contributor
  • Badges: CI, benchmark gate, Docker, latest release, MIT/Apache-2.0
  • Intro restructured: the oracle-parity benchmark results now lead (44 vs 41 VDL2; 161 vs 162 Mode S + 7 exclusive), AIS-catcher and dump1090 join the replaced-tools list, and the buried benchmarks paragraph in the outputs section is removed as redundant
  • Mode table: validation cells state the CI-fenced benchmark results per mode
  • Staleness fixes: install examples 0.9.0 → 0.14.0; the legacy/ link removed (deleted in Remove the legacy pre-rewrite tree #84, preserved in history); ARCHITECTURE.md status header and ASF2.md body list brought to v0.14.0

🤖 Generated with Claude Code

- Badges: CI, benchmarks gate, Docker, release, dual license
- Intro: benchmark results up front (44 vs 41 VDL2, 161 vs 162 Mode S);
  AIS-catcher and dump1090 added to the replaced-tools list
- Mode table validation cells state the CI-fenced benchmark results
- Install examples bumped 0.9.0 -> 0.14.0; stale legacy/ link removed
  (the tree was deleted in #84; history preserves it)
- ARCHITECTURE.md status header reflects v0.14.0 + oracle parity;
  ASF2.md body list current

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@kevinelliott, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 13 minutes and 10 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more credits in the billing tab to continue.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7eaac123-8d82-4054-800d-7654f02d756e

📥 Commits

Reviewing files that changed from the base of the PR and between 6aa9d9d and 7732a06.

📒 Files selected for processing (3)
  • README.md
  • docs/ARCHITECTURE.md
  • docs/ASF2.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch readme-polish

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 7732a063ba

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
sudo apt install ./xng-0.14.0-arm64.deb # pulls runtime deps
# or
tar xzf xng-v0.9.0-x86_64-unknown-linux-gnu.tar.gz && sudo cp xng-*/xng /usr/local/bin/
tar xzf xng-v0.14.0-x86_64-unknown-linux-gnu.tar.gz && sudo cp xng /usr/local/bin/

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Copy the binary from the extracted tarball directory

For the tarball install path, this now fails after extraction because the release workflow packages the binary under a versioned directory (PKG=xng-${GITHUB_REF_NAME}-${{ matrix.target }} and tar -C dist ... ${PKG} in .github/workflows/release.yml lines 44-47), not as ./xng at the current directory. Users following the README for Linux/macOS tarballs will get cp: cannot stat 'xng'; keep the previous xng-*/xng source or include the full extracted directory name.

Useful? React with 👍 / 👎.

@kevinelliott kevinelliott merged commit fe03312 into master Jun 11, 2026
3 checks passed
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