[Doc] Add missing info to building/testing section of README #307
Conversation
| C:\wil> scripts\init.cmd -c clang -g ninja -b debug | ||
| ``` | ||
| You can execute `init.cmd --help` for a summary of available options. The scripts use a common directory pattern of `build/$(compiler)$(arch)$(type)` for the build output root. E.g. `build/clang64debug` when using Clang as the compiler, x64 as the architecture, and Debug as the build type. It is this directory where you will want to build from. For example, if you initialized using the command above, you can build the tests like so: | ||
|
|
There was a problem hiding this comment.
I've had great luck doing the "open folder with existing code" option in very recent VS builds - the cmake integration picks up the configurations and defaults to x64-debug so it's nearly "load and hit F5."
There was a problem hiding this comment.
I'm a fan! I left a similar comment to @dunhor---I've had bad luck with C++ IntelliSense in VS Code in the past. Is there anything specific I need to do? I'd love to document it.
There was a problem hiding this comment.
I gave this a shot and found:
- IntelliSense works flawlessly.
- Building "work" but does not detect the test executables. Not sure what it ends up building.
- F5 crashes on launch. Not sure what it's launching
- Cannot run tests. They are not discovered in Test Explorer.
versus the generated .sln which correctly builds and can debug. I documented as such.
Was that your experience? I'm happy to update if you have a better method, or I'm happy to let you update.
|
LGTM 👍. @jonwis if you have no additional comments or requests, we can go ahead and merge. No need to wait for a build to complete for this. |
Today, the README is missing a few minor requirements (install Nuget, e.g.) and doesn't explain in detail how to setup your dev environment with IntelliSense.
This change adds that missing documentation, including specific steps to create a
.slnfile with IntelliSense.