79fcf3b686
* Replace intra-repo absolute URLs with relative ones. * Replace remaining pointers to `vector-of-bool` with `microsoft` in the URLs than must remain absolute. Co-authored-by: Garrett Campbell <86264750+gcampbell-msft@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| images | ||
| README.md | ||
| build.md | ||
| cmake-options-configuration.md | ||
| cmake-presets.md | ||
| cmake-settings.md | ||
| configure.md | ||
| debug-launch.md | ||
| debug.md | ||
| faq.md | ||
| how-to.md | ||
| kits.md | ||
| pull_request_template.md | ||
| tasks.md | ||
| troubleshoot.md | ||
| variants.md | ||
README.md
CMake Tools for Visual Studio Code documentation
CMake Tools is an extension designed to make it easy to work with CMake-based projects.
If you are new, try the CMake Tools quick start and see the frequently asked questions.
- Create a new project
- Configure a project
- Build a project
- Debug a project
- Pass command-line arguments to the debugger
- Set up include paths for C++ IntelliSense
- CMake configuration process overview
- The CMake tools configure step
- The configure step outside of CMake Tools
- Clean configure
- Variant YAML example
- Variant schema
- Variant settings
- Variant options
- How variants are applied
- Large variant file example
- Select a launch target
- Quick debugging
- Debug using a launch.json file
- Run without debugging
- Debugging CMake
Configure CMake Tools settings
- Configure and build with CMake Presets
- Supported CMake and CMakePresets.json versions
- Enable CMakePresets.json in the CMake Tools extension
- Configure and build
- CMake: Configure
- CMake: Select Build Preset
- CMake: Build
- Test
- CMake: Select Test Preset
- CMake: Run Tests
- Add new presets
- Add new Configure Presets
- Add new Build Presets
- Edit presets
- Select your generator
- Set and reference environment variables
- Vcpkg integration
- Command substitution in launch.json and settings.json
- Ignored settings
- Unsupported commands
- Troubleshooting
- Run CMake from the command line or a Continuous Integration (CI) pipeline
- Sourcing the environment when building with command line generators on Windows
- Example CMakePresets.json file
- Common issues and resolutions
- CMake Tools is unable to provide IntelliSense configuration
- Green squiggles beneath #include directives
- Debugging ignores launch.json
- Reset CMake Tools extension state
- Increase the logging level
- Check the log file
- Get help