docs: add 'Why Pure Rust (and not libgit2)?' section to README#36
Merged
Conversation
Explain the rationale for reimplementing Git in pure Rust instead of wrapping libgit2 or shelling out to the git binary. Cover FFI blocking issues, env-var leakage and portability concerns of shelling out, zero-copy performance, the narrower plumbing-only scope vs gitoxide, and the static-linking benefit of the Lite edition.
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
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.
Summary
Add a new section to the README titled `### Why Pure Rust (and not libgit2)?` that explains the deliberate engineering choice to reimplement Git in pure Rust rather than wrap `libgit2` or shell out to the `git` binary.
Why
The current README describes what agit is and how it works, but does not explain why it is built the way it is. Contributors and evaluators landing on the project from gitoxide or libgit2 frequently ask the same question: "why not just use X?" This section gives a direct, opinionated answer with the technical specifics they care about.
What the section covers
Constraints
Checklist