docs: overhaul README + refresh benchmark chart - #53
Merged
Conversation
README: - lead with the "why" (a file you own, not a service you rent), BitNet as proof - two clearly-named install paths (model baked in / your own model) - "Why geist?" umbrella over the feature sections; drop section emojis - add stat strip + community/good-first-issue badges and links - cut 8 GIFs to 2 (hero + Pi5), trim Usage, fold benchmark numbers into Docs - fix broken anchors, dangling "Path ①" ref, unify clone URL to geisten/geisten - restore Contributing onboarding (difficulty table + CoC/Discussions links) Benchmark chart: - add all 12 measurements, tag each system with its OS (Linux/macOS) - record baseline engine versions per row (llama.cpp d05fe1d/b9827, bitnet.cpp master) compare_ternary_pi5.sh: - pin llama.cpp / bitnet.cpp refs via LLAMA_REF/BITNET_REF for reproducible runs
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.
README
geisten/geistenBenchmark chart (
headline_benchmarks.svg)d05fe1d(Pi 5, M1 Max) /b9827(x86); bitnet.cppmastercompare_ternary_pi5.shllama.cpp/bitnet.cpprefs viaLLAMA_REF/BITNET_REFfor reproducible reference buildsFollow-ups (not in this PR)