docs(readme): rewrite top-level README for hydrologists with plain pitch and uv install#25
Merged
Conversation
…tch and uv install
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.
docs(readme): rewrite top-level README for hydrologists with plain pitch and uv install
What changed
Rewrote the top-level README around the canonical plain-language watershed pitch, changed install guidance to
uv add pyshedwith a smallpip install pyshedfallback, deleted numeric performance figures in favor of qualitative first-open-is-slower guidance, removed "and friends", stripped engineering jargon and em dashes, and reworded the PyO3 repository-layout row.Why
The README's audience is hydrologists; it carried unexplained storage-engine jargon, unbacked performance numbers, and a pip-first install that the docs campaign standardizes on uv.
Verification
/Users/nicolaslazaro/Desktop/work/shed/crates/python/.venv/bin/mkdocs build --strict -f mkdocs.yml -d .mkdocs-site-check && rm -rf .mkdocs-site-check: passed.! grep -q '—' README.md: passed.! grep -qi 'and friends' README.md: passed.! grep -q 'HDX' README.md: passed.! grep -Eiq '[0-9]+([.,][0-9]+)?[[:space:]]*(ms|millisecond|second|minute)' README.md: passed.grep -q 'uv add pyshed' README.md: passed.grep -q 'pip install pyshed' README.md: passed.grep -q 'the whole upstream area that drains to it' README.md: passed.! grep -Eiq 'row[- ]group|range read|rayon|pyo3|projjson|hilbert|xdg|object[- ]stor' README.md: passed.! grep -q 'COG' README.md: passed.! grep -Eiq "isn'?t just|not just|not merely|not only|it'?s not|it is not" README.md: passed.grep -qi 'watershed' README.md && ! grep -qi 'drainage basin' README.md: passed.test "$(git diff --name-only)" = "README.md": passed before commit.test "$(git diff --name-only HEAD~1 HEAD)" = "README.md": passed after commit.