Onboarding: quickstart example, CMake integration, umbrella header - #3
Merged
Conversation
Makes adoption a five-minute job instead of a reverse-engineering exercise: - examples/quickstart.cpp: a complete, compilable, SELF-CHECKING tour of the whole pipeline (quantize -> multi-threaded build -> persist -> zero-rebuild reload -> Hamming / asymmetric / exact search -> contexts -> filtering -> soft delete -> slot reclamation). Exits non-zero on any failed check, so it doubles as a smoke test; a new CI job builds and runs it via BOTH make and CMake on every push, so the example can never drift from the library. Verified on Windows/MinGW and (via container) Linux arm64. - CMakeLists.txt: header-only INTERFACE target edgevector::edgevector with FetchContent/add_subdirectory consumption, Threads linked, header install rule, and a clear fatal error on MSVC instead of a wall of builtin errors. - include/edgevector/edgevector.hpp: single-include umbrella header with EDGEVECTOR_VERSION macros for vendored-copy identification. - README: "Getting it into your project" section - vendor / FetchContent / add_subdirectory, the flags that matter, and a pointer to the quickstart. - examples/Makefile with the same ARCH/RUNNER knobs as tests/. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017ULiWeodALX2ZQiLKvTw25
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Makes incorporating EdgeVector a five-minute job:
examples/quickstart.cpp— complete, compilable, self-checking tour of the whole pipeline; exits non-zero on any failed check. A new CI job builds and runs it via both make and CMake on every push so it can never drift from the library.edgevector::edgevectorINTERFACE target (FetchContent /add_subdirectory), Threads linked, install rule, fatal-with-explanation on MSVC.edgevector/edgevector.hppumbrella header +EDGEVECTOR_VERSIONmacros.Validated: quickstart green on Windows/MinGW (make) and Linux (CMake, incidentally on arm64 via container emulation).
🤖 Generated with Claude Code
https://claude.ai/code/session_017ULiWeodALX2ZQiLKvTw25