Add sccache as an "Enable Fast Compiles (Optional)" section.

[mholiv]

How can Bevy's documentation be improved?

I would be happy to make this change if people are interested.

The docs at https://bevy.org/learn/quick-start/getting-started/setup/ suggest several optional ways to speed up compiles. An additional (and easy) way to improve things further might be recommending setting up sccache.

It can be done as simply as:

1. Install sccache
cargo install sccache

2. Enable sccache in your game
In .cargo/config add:
[build]
rustc-wrapper = "/home/caitlin/.cargo/bin/sccache"

This helps A TON if the bevy dev is doing things like building their game with different features.

[kfc35]

One person thumbs up’d this issue on Discord, so I believe you have at least one person’s support :) Since it’s small, you can go for it!

The place to do this would be in https://github.com/bevyengine/bevy-website

content/learn/quick-start/getting-started/setup.md

[alice-i-cecile]

I'm generally reluctant to add even more steps to that section, and feel strongly that the order of this content is misplaced. Too many users have jumped into complex setup and gotten overwhelmed, or ended up with a broken setup and no good way to debug what step failed.

[mholiv]

@alice-i-cecile

I do see your point. Yah. From a new user perspective I think keeping the getting started section as simple as possible makes sense.

Later in there could be an additional or optional optimization section?

I would say it could be a chapter in the bevy book, but it seems like (while there are amazing 3rd party documents) there is no such official document.

[alice-i-cecile]

Yeah, the real fix is "finish the new book", and move the advanced dev workflow optimization content to its own section (linked from Getting Started), as you say :)

There's a stub chapter already that's not publicly visible. Can you add this content there?

[mockersf]

This helps A TON if the bevy dev is doing things like building their game with different features.

I don't think it should? sccache won't change anything if all your compilations are using the same target folder, its only advantage is using across different projects

[mholiv]

This helps A TON if the bevy dev is doing things like building their game with different features.

I don't think it should? sccache won't change anything if all your compilations are using the same target folder, its only advantage is using across different projects

You are right. I should have been more clear. In a normal environment when you just compile / run tests against the host it is less useful.

I build / test my game (with the steam feature) in Valve's sniper runtime environment threw podman with sccache. Sccache saves the full recompile efforts there. Same with the aarch64 and risc-v builds in their respective cross environments. I can add this to the stub that alice mentioned. Defiantly puts this out of "getting started" territory though. lol.