Skip to content

Commit f93e161

Browse files
jasondamingclaude
authored andcommitted
Clarify Enable Desktop Support checkbox for all project types (#3148)
* Clarify Enable Desktop Support checkbox for all project types - Java: Has no effect, can be checked or unchecked - C++: Must be checked for simulation, unit tests, Romi/XRP projects - Added note about third-party library compatibility - Removed Python reference (doesn't use this project creator) Fixes #3146 * Clarify that Enable Desktop Support has no effect on Romi/XRP templates Per Gold856's comment, the C++ Romi/XRP templates don't have an includeDesktopSupport variable in the build.gradle, so the Enable Desktop Support checkbox is a no-op for those templates. Updated documentation to explicitly state that the checkbox has no effect for Romi and XRP templates and can be left checked or unchecked. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Move simulation link to Enable Desktop Support line Per sciencewhiz's comment, moved the robot simulation introduction link from the note to the main "Enable Desktop Support" line. The link is a general reference about simulation, not specifically about conditional compilation, so it was misleading to have it in the note that discusses vendor library compatibility issues. Also removed the conditional compilation reference from the note since the linked documentation doesn't address that topic. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent f09c73a commit f93e161

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

source/docs/software/vscode-overview/creating-robot-program.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,13 @@ The elements of the New Project Creator Window are explained below:
126126
5. **Project Name**: The name of the robot project. This also specifies the name that the project folder will be given if the Create New Folder box is checked.
127127
6. **Create a New Folder**: If this is checked, a new folder will be created to hold the project within the previously-specified folder. If it is *not* checked, the project will be located directly in the previously-specified folder. An error will be thrown if the folder is not empty and this is not checked.
128128
7. **Team Number**: The team number for the project, which will be used for package names within the project and to locate the robot when deploying code.
129-
8. **Enable Desktop Support**: Enables unit test and simulation. While WPILib supports this, third party software libraries may not. If libraries do not support desktop, then your code may not compile or may crash. It should be left unchecked unless unit testing or simulation is needed and all libraries support it.
129+
8. **Enable Desktop Support**: Enables unit test and simulation support (see :doc:`/docs/software/wpilib-tools/robot-simulation/introduction`).
130+
131+
- **Java**: This option has no effect and can be left checked or unchecked
132+
- **C++**: Checking this option enables desktop compilation, which is required for simulation and unit tests
133+
- **Romi/XRP**: This option has no effect for Romi and XRP templates and can be left checked or unchecked
134+
135+
.. note:: While WPILib fully supports desktop builds, some third-party vendor libraries may not. If a library doesn't support desktop compilation, your C++ code may not compile or may crash when running simulation.
130136

131137
Once all the above have been configured, click "Generate Project" and the robot project will be created.
132138

0 commit comments

Comments
 (0)