Skip to content

Conversation

@nnethercote
Copy link
Collaborator

Four crates have a README.md. These will only be seen by people interacting directly with the rust-cuda repository. A much better place for documentation is in the crate's top-level rustdocs. This PR removes some READMEs and moves relevant documentation into those rustdocs.

@nnethercote nnethercote requested a review from frjnn as a code owner December 9, 2025 02:25
@nnethercote nnethercote requested review from LegNeato and removed request for frjnn December 9, 2025 02:25
@nnethercote nnethercote force-pushed the rm-READMEs branch 3 times, most recently from ce3ce0f to 2d1c4ec Compare December 11, 2025 00:35
@nnethercote
Copy link
Collaborator Author

The CI failures are due to the path-tracer breakage fixed by #342.

There is currently some overlap between the README and the rustdocs, but
the latter is truncated, presumably accidentally. This commit moves all
the contents into the rustdocs.
It's very short, and the rustdocs have much more detail.
It's extremely short and out of date.
And move its contents into its rustdocs. I also did a light line edit of
the text while moving it, to improve readability.
They're non-standard and unnecessary.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants