Skip to content

docs: modernize README quick start - #64

Merged
gouyt13 merged 1 commit into
mainfrom
docs/readme-quick-start
Aug 22, 2026
Merged

docs: modernize README quick start#64
gouyt13 merged 1 commit into
mainfrom
docs/readme-quick-start

Conversation

@gouyt13

@gouyt13 gouyt13 commented Aug 22, 2026

Copy link
Copy Markdown
Member

Summary

  • reorganize the README around Python and C++ quick starts
  • add a self-contained Python IVF example and clarify SIMD requirements
  • add project badges, documentation links, SymphonyQG paper, citation, and license sections
  • declare NumPy as a runtime dependency

Verification

  • pytest --tb=short -q (54 passed)
  • clean pip install built and installed rabitqlib with NumPy
  • README Python IVF example returned the documented output shapes
  • fresh C++ Release build succeeded
  • ctest completed with 16/16 tests passing
  • git diff --check

@gouyt13
gouyt13 merged commit 4947556 into main Aug 22, 2026
5 checks passed
@gouyt13
gouyt13 deleted the docs/readme-quick-start branch August 22, 2026 04:09
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