Skip to content

Commit afe3e1f

Browse files
lpilXAMPPRocky
andauthored
Re-introduce "getting started" section (#205)
* Re-introduce "getting started" section This section details how to use the project as a newcomer. The previous guide location made it hard to find. * Feedback Co-authored-by: XAMPPRocky <[email protected]> Co-authored-by: XAMPPRocky <[email protected]>
1 parent 3480521 commit afe3e1f

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,13 @@ pub fn main_fs(input: Input<Vec4>, mut output: Output<Vec4>) {
3939

4040
See [source](examples/shaders/sky-shader/src/lib.rs) for full details.
4141

42+
## Getting started
43+
44+
Check out [The `rust-gpu` Dev Guide][gpu-guide] for information on how to get started with using it in your projects.
45+
46+
[gpu-guide]: https://embarkstudios.github.io/rust-gpu/book/
47+
48+
4249
## Background
4350

4451
Historically in games GPU programming has been done through writing either HLSL, or to a lesser extent GLSL. These are simple programming languages that have evolved along with rendering APIs over the years. However, as game engines have evolved, these languages have failed to provide mechanisms for dealing with large codebases, and have generally stayed behind the curve compared to other programming languages.
@@ -96,9 +103,7 @@ There are a few different components to this repo:
96103

97104
We welcome community contributions to this project.
98105

99-
If you would like to get started, be sure to checkout the [`rust-gpu` dev guide][gpu-guide] and our [Contributor Guide](CONTRIBUTING.md) for more information on how to get started.
100-
101-
[gpu-guide]: https://embarkstudios.github.io/rust-gpu/book/
106+
Please read our [Contributor Guide](CONTRIBUTING.md) for more information on how to get started.
102107

103108
## License
104109

0 commit comments

Comments
 (0)