Write a descriptive README with a quick-start example and docs link - #33
Merged
Conversation
The README was two lines with no usage example, installation instructions, or pointer to any documentation. Add a real description of what the model does, an install command, a runnable polyfc() example, workflow status badges, and a link to the new GitHub Pages docs site (meyer-lab.github.io/valentBind).
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.
Summary
The README was two lines with no usage example, install instructions, or link to documentation. Rewrote it with:
polyfc()quick-start example.Test plan
uv run pytestpasses (unaffected, README-only change)uv run ruff format --check .passes on the embedded code block