Skip to content

[Doc] Add missing info to building/testing section of README - #307

Merged
Jon Wiswall (jonwis) merged 8 commits into
microsoft:masterfrom
citelao:patch-2
Apr 5, 2023
Merged

Jon Wiswall (jonwis) merged 8 commits into
microsoft:masterfrom
citelao:patch-2

Conversation

@citelao

Copy link
Copy Markdown
Contributor

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 .sln file with IntelliSense.

@jonwis Jon Wiswall (jonwis) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the cleanup!

Comment thread README.md Resolved
Comment thread README.md
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:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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."

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread README.md Resolved
@dunhor

Copy link
Copy Markdown
Member

LGTM 👍. Jon Wiswall (@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.

@jonwis
Jon Wiswall (jonwis) merged commit 56e3e5a into microsoft:master Apr 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants