README.md: Don't require the user to `mkdir`/`cd`

ddnet / ddnet

DDraceNetwork, a free cooperative platformer game

https://ddnet.org

Other

510 stars 381 forks source link

README.md: Don't require the user to `mkdir`/`cd` #8365

Open heinrich5991 opened 2 weeks ago

heinrich5991 commented 2 weeks ago

Also remove the -j$(nproc) parameter, if the user wants to fast, they should use ninja.

Checklist

[ ] Tested the change ingame
[ ] Provided screenshots if it is a visual change
[ ] Tested in combination with possibly related configuration options
[ ] Written a unit test (especially base/) or added coverage to integration test
[ ] Considered possible null pointers and out of bounds array indexing
[ ] Changed no physics that affect existing maps
[ ] Tested the change with ASan+UBSan or valgrind's memcheck (optional)

heinrich5991 commented 2 weeks ago

I feel like the README isn't the right place for educating the user about make parameters. If we want the user to get a faster build, we should provide instructions for ninja instead. Should I change the instructions to ninja?

Peter0x44 commented 2 weeks ago

You can pass -j to cmake --build as well, and it should do the right thing.

Peter0x44 commented 2 weeks ago

Actually, -j$(nproc) is still necessary, otherwise that is literally what it passes through to make, and it will basically fork bomb you. (make -j<empty> means "spawn unlimited processes")

I think it's okay to put cmake -Bbuild -j$(nproc) in the readme, then even the users who copy paste mindless get faster builds, regardless of generator used.

heinrich5991 commented 2 weeks ago

I think it's okay to put cmake -Bbuild -j$(nproc) in the readme, then even the users who copy paste mindless get faster builds, regardless of generator used.

Then we can also just include ninja in the requirements and add -GNinja.