From 3f14ab48ddfb8eac655f5ecf11c5d454c53ce38e Mon Sep 17 00:00:00 2001 From: Christian Legnitto Date: Wed, 20 Nov 2024 18:25:31 -0400 Subject: [PATCH 1/3] Revert "Temporarily remove README from code" This reverts commit 06cef1a8212fe58c51b75285578f64023754a853. --- .../code/README.md | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 blog/2024-11-21-optimizing-matrix-mul/code/README.md diff --git a/blog/2024-11-21-optimizing-matrix-mul/code/README.md b/blog/2024-11-21-optimizing-matrix-mul/code/README.md new file mode 100644 index 0000000..1ac1da3 --- /dev/null +++ b/blog/2024-11-21-optimizing-matrix-mul/code/README.md @@ -0,0 +1,21 @@ +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. From 82810fabd4829a7c9653bbc794df336a08ec7dac Mon Sep 17 00:00:00 2001 From: Christian Legnitto Date: Wed, 20 Nov 2024 18:25:56 -0400 Subject: [PATCH 2/3] Ignore markdown files in blog code Without this, the README.md files were picked up as blog posts. --- docusaurus.config.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/docusaurus.config.ts b/docusaurus.config.ts index b01583d..b44e0dc 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -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", From 9e9d8644bded804d8b6903608fead84fa8233aca Mon Sep 17 00:00:00 2001 From: Christian Legnitto Date: Wed, 20 Nov 2024 18:29:10 -0400 Subject: [PATCH 3/3] Remove truncate marker in readme As the blog plugin is no longer parsing this, it no longer throws without it --- blog/2024-11-21-optimizing-matrix-mul/code/README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/blog/2024-11-21-optimizing-matrix-mul/code/README.md b/blog/2024-11-21-optimizing-matrix-mul/code/README.md index 1ac1da3..c664f91 100644 --- a/blog/2024-11-21-optimizing-matrix-mul/code/README.md +++ b/blog/2024-11-21-optimizing-matrix-mul/code/README.md @@ -1,7 +1,5 @@ The Rust code that accompanies the blog post. - - You will find: 1. A binary (`blog`) that you can run with `cargo run`