Sharpmake icon indicating copy to clipboard operation
Sharpmake copied to clipboard

Sharpmake needs better documentation

Open Zathyy opened this issue 8 months ago • 3 comments

Note: i really love this build tool, but its lacking documentation.

its very unclear how to do things.

only way i can find out how to do things is either create a issue wait a few days or go through source or just typing conf. and seeing what suggestions vs gives me, its very unclear.

Zathyy avatar Mar 31 '25 15:03 Zathyy

The typical way we use it at Ubisoft in a large project: we write CommonProject and CommonSolution base classes that do most of the multi-platform setup we want, and then we add project classes derived from CommonProject for each module/vcxproj we want to generate. We do a LOT of copy-paste and typing conf. or target. to see what auto-completes. After a while, you get used to the Configure overload pattern (we have some ideas in our samples).

bchampoux avatar Mar 31 '25 17:03 bchampoux

i mean ye, thats how i have it now kinda, but it would still be nice with more examples and more documentation.

Zathyy avatar Mar 31 '25 17:03 Zathyy

I have been using Sharpmake professionally for more than 3 years. Used it across multiple platforms and engines. If you have a set of questions and/or areas you want better documentation for, more than happy to help write down some stuff.

Sharlock93 avatar Dec 01 '25 22:12 Sharlock93