Move most of the README into the Guide. #334
Merged
Conversation
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
Collaborator
Author
|
See the updated README here. |
nnethercote
force-pushed
the
merge-README-guide
branch
from
3932f85 to
278c0a3
Compare
LegNeato
approved these changes
Dec 5, 2025
README.md
Outdated
| ## Documentation | ||
|
|
||
| A sample `.devcontainer.json` file is also included, configured for Ubuntu 24.02. Copy this to `.devcontainer/devcontainer.json` to make additional customizations. | ||
| Please see [The Rust CUDA Guide](https://rust-gpu.github.io/rust-cuda/index.html) for all the |
Contributor
There was a problem hiding this comment.
nit: I'd remove the index.html to be cleaner
It annoys me to have stuff split between the README and the Guide. This commit moves most of the README contents into the Guide's introduction, (which was all but empty anyway). I also did some line editing of the moved text. Other minor structural changes: - Rename the first chapter file from `README.md` (not to be confused with the top-level README) to `introduction.md`, to match the chaper name. - Move "Supported Features" and the FAQ to unnumbered chapters at the end -- making them quasi-appendices -- because they're supplementary. This means the "Getting Started" section now follows immediately on from the introduction, which is good.
Something I learned recently.
This showed up in Rust-GPU#220 and Rust-GPU#327.
This file currently uses a mix of 2-space and 4-space indents in examples.
Currently they don't show up. They need to be within the `src/` directory to get included in the generated output.
nnethercote
force-pushed
the
merge-README-guide
branch
from
80decdd to
afe3fe2
Compare
Collaborator
Author
|
New version is up! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
It annoys me to have stuff split between the README and the Guide. This commit moves most of the README contents into the Guide's introduction, (which was all but empty anyway). I also did some line editing of the moved text.
Other minor structural changes:
README.md(not to be confused with the top-level README) tointroduction.md, to match the chaper name.