Skip to content

Make code READMEs not be treated as blog posts #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions blog/2024-11-21-optimizing-matrix-mul/code/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
The Rust code that accompanies the blog post.

You will find:

1. A binary (`blog`) that you can run with `cargo run`
2. Benchmarks that you can run with `cargo bench`
3. GPU shaders/kernels written in Rust
4. CPU code that takes the shaders and runs it on the GPU (via `wgpu`) or the CPU with a
simulated harness
5. Some tests that you can run with `cargo test`

A good place to start to get the lay of the land is the workspace's `Cargo.toml` in this
directory.

**Any changes to these files should ensure that the blog post is still correct as it
uses line numbers to embed code snippets.**

Note: Everything needs to be run with `--release` to work around
https://github.com/Rust-GPU/rust-gpu/issues/29.
1 change: 1 addition & 0 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ const config: Config = {
xslt: true,
},
editUrl: "https://github.com/Rust-GPU/rust-gpu.github.io/tree/main/",
exclude: ["*/code/**"],
onInlineTags: "throw",
onInlineAuthors: "throw",
onUntruncatedBlogPosts: "throw",
Expand Down