Skip to content

Rewrite README for discovery and onboarding - #519

Merged
StevenMagnet merged 1 commit into
mainfrom
docs/readme-refresh-2026-07
Jul 23, 2026
Merged

Rewrite README for discovery and onboarding#519
StevenMagnet merged 1 commit into
mainfrom
docs/readme-refresh-2026-07

Conversation

@StevenMagnet

Copy link
Copy Markdown
Collaborator

Summary

Rewrites the README to improve GitHub discovery and make the repository easier to evaluate and use.

  • states the repository purpose in the first screen
  • adds verified requirements and build/install instructions
  • links the relevant SDKs, examples, and documentation
  • separates current capabilities from limitations
  • avoids unverified performance claims

Draft for technical review before merging.

@StevenMagnet
StevenMagnet marked this pull request as ready for review July 23, 2026 15:55
@StevenMagnet
StevenMagnet merged commit b69e99b into main Jul 23, 2026
14 checks passed
@StevenMagnet
StevenMagnet deleted the docs/readme-refresh-2026-07 branch July 23, 2026 15:56

@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: af425f12aa

ℹ️ 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
```bash
cmake -S . -B build -DAE_BUILD_TESTS=ON
cmake --build build --parallel
ctest --test-dir build --output-on-failure

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 Keep test command compatible with CMake 3.16

This README advertises CMake 3.16+ above, but this command uses ctest --test-dir, and the CTest manual marks that option as "Added in version 3.20". Users on supported CMake 3.16–3.19 will hit an unsupported option when they try to run tests; either raise the documented minimum or use the existing cd <build-dir> && ctest . ... form.

Useful? React with 👍 / 👎.

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