Make the README a PyPI listing, and add a real contributing guide - #11
Merged
Conversation
This README is the PyPI project page. It opened with 'a thin shell over the engine ... loads the cdylib via ctypes and drives the stable C ABI', then went straight into building from source, running tests and provenance. None of that helps someone deciding whether to install it. Its one example also used undefined 'old' and 'new' — the same fragment that made the 0.0.1 headline example raise NameError. It is now a runnable program with its real output. Architecture, build and test instructions move to CONTRIBUTING.md. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Explains what the project is, how the repositories fit together, where a given change belongs, and the release-candidate branching rule. Links the docs site. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
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.
The README is the PyPI project page. It opened with
a thin shell over the engine ... loads the cdylib via ctypes and drives the stable C ABI, then went into building from source, tests and provenance — none of which helps someone deciding whether to install it. Its one example used undefinedold/new, the same fragment that made the 0.0.1 headline example raiseNameError.README is now a listing: what it does, install (with the Python 3.12 floor and the fact that the wheel is self-contained), a runnable quick start with its real output, the CLI, docs links, privacy.
CONTRIBUTING.md is now a real guide: what the project is, how the repositories fit together, where a given change belongs, the release-candidate branching rule, and what a good PR looks like.
Docs: https://buchochelliq-labs.github.io/intentumdiff-docs/
🤖 Generated with Claude Code