Repository navigation
README: restructure into a centered hero + persuasion funnel - #42
Merged
Merged
Conversation
Reorder README as pitch -> proof -> install so the two most persuasive assets (code samples and benchmark table) move up out from under the ~95-line 6-way install wall. - Centered hero: bold tagline + italic subheader, curated two-row badge strip (identity/trust + registry "try & get" shields), Compiler Explorer CTA, and a stat strip. Drops the Codacy grade badge and the misleading vcpkg.yml/xrepo.yml CI badges; fixes the four dead href="#" wrappers by rendering static <img>s; swaps CI shields for registry version shields. - New sections: "Why" benefit bullets, "API at a glance" table (header -> functions -> what it does), "Which library should I pick?" (benchmark table + feature matrix + accuracy note + <details> methodology, merging the old Benchmarks and "When not to use"), and "Requirements & compatibility" (CI compiler matrix, sanitizers, semver). - Move the two Usage code blocks above Installation; collapse the five non-FetchContent install methods into a single <details>. - Add an inline TOC, Credits (android-maps-utils lineage), and a star CTA. - Leave HTML-comment image placeholders per the asset path contract (hero-pipeline.gif, demo.gif, benchmarks.svg, gallery/*) - no <img> tags for not-yet-existing assets, so nothing renders broken. Text-only, no new assets. No information loss: every prior fact/link is preserved (relocated or behind <details>); dropped badge URLs are the brief-authorized cuts or cosmetic image swaps whose facts survive.
- Stat strip: drop the cherry-picked '~5x S2 / ~1.9x Boost' area framing; lead with raw throughput. '1.6-1.9x' -> '~1.6x' so the claim matches the visible table (0.79/0.50); the N-dependent 1.9x is explained in methodology. - Methodology: note S2 is faster on distance_between (honest counterpoint). - Merge Support into 'Contributing & support' (both were 'open an issue'). - Drop the redundant Compiler Explorer badge (still 2 CTAs remain). - xrepo badge now links to the package page, not the whole repo.
…refs - Hero stat strip: bare throughput -> relative comparisons (Boost/S2/haversine) - Tagline & footer: remove Stack Overflow framing - Drop redundant Compiler Explorer sub-line; API reference as a 3-item list
Drop the distance clause (parity, not a win; still stated in Why + the benchmark table) so the strip stays on a single line.
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.
Restructures
README.mdinto a centered "hero" + a top-to-bottom persuasion funnel(pitch → proof → install), so the two most convincing assets — the code samples and the
benchmark numbers — sit above the fold instead of below a ~95-line install wall.
Text-only change (
README.md, +220 / −147). No new images are introduced: asset slotsare left as HTML comments for a follow-up PR, so nothing renders broken today.
What changed
CTA, and a one-line stat strip (
67M polygons/s (~1.9× Boost, ~5× S2) · 40M distance calls/s · 1.6–1.9× faster than S2 on point_at_distance).vcpkg.yml/xrepo.ymlCI badges(they read as "available on vcpkg"); Row 2 now uses real registry/version shields
(vcpkg / xrepo / build2 / Conan-pending / Meson-pending). Fixed the dead
href="#"wrappers.Which library should I pick? (benchmark table + feature matrix + accuracy note, merging the
old Benchmarks and When not to use) → Installation → Requirements & compatibility →
API reference / Contributing / Credits / Support / License.
<details>, shrinking the wall to a few visible lines.(android-maps-utils lineage), and an unobtrusive star CTA.
Verification
in-page TOC anchors resolve.
include/geo/(nothing invented;point_at_distancecorrectly attributed tospherical.hpp).<details>.Follow-ups (not in this PR)
Image/GIF assets (hero pipeline gif, benchmark chart, terminal demo, operations gallery) and a
reproducible generation pipeline are prepared on a separate branch and will land in a follow-up;
the HTML-comment placeholders here mark exactly where they slot in.