Skip to content

Commit 3bb38c6

Browse files
committed
Update creating a new project for 2027 alpha 3
Updates for alpha 3 project creator
1 parent c25065c commit 3bb38c6

File tree

6 files changed

+61
-32
lines changed

6 files changed

+61
-32
lines changed

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

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -112,38 +112,48 @@ Once we've decided on a base class, we can create our new robot project. Bring
112112
.. image:: images/creating-robot-program/create-new-project.png
113113
:alt: Highlights the "WPILib: Create a new project" command.
114114

115-
This will bring up the "New Project Creator Window:"
115+
This will bring up the "WPILIb New Project Creator"
116116

117117
.. image:: images/creating-robot-program/new-project-creator.png
118-
:alt: The new project creator screen.
118+
:alt: The project type selector of the WPILib New Project Creator
119119

120-
The elements of the New Project Creator Window are explained below:
120+
The **Project Type** chooses between an empty template project of one of the base classes, or a :doc:`WPILib example project </docs/software/examples-tutorials/wpilib-examples>`. Additionally, a template exists for :ref:`Command-based <docs/software/commandbased/commands-v2/what-is-command-based:What is "command-based" programming?>` projects, which are built on the :code:`TimedRobot` base class but include a number of additional features - this type of robot program is highly recommended for new teams.
121121

122-
1. **Project Type**: The kind of project we wish to create. This can be an example project, or one of the project templates provided by WPILib. Templates exist for each of the robot base classes. Additionally, a template exists for :ref:`Command-based <docs/software/commandbased/commands-v2/what-is-command-based:What is "command-based" programming?>` projects, which are built on the :code:`TimedRobot` base class but include a number of additional features - this type of robot program is highly recommended for new teams.
123-
2. **Language**: This is the language (C++ or Java) that will be used for this project.
124-
3. **Base Folder**: If this is a template project, this specifies the type of template that will be used.
125-
4. **Project Location**: This determines the folder in which the robot project will be located.
126-
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.
127-
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.
128-
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 support (see :doc:`/docs/software/wpilib-tools/robot-simulation/introduction`).
122+
After making the selections, click :guilabel:`Next`.
130123

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
124+
This will bring up the language and base selection window.
134125

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.
126+
.. image:: images/creating-robot-program/new-project-creator-language.png
127+
:alt: The language and base page of the WPILib New Project Creator
136128

137-
Once all the above have been configured, click "Generate Project" and the robot project will be created.
129+
1. **Language**: This is the language (C++ or Java) that will be used for this project.
130+
2. **Project Base**: This box is used to select the base class or example to generate the project from.
138131

139-
.. note:: Any errors in project generation will appear in the bottom right-hand corner of the screen.
132+
After making the selections, click :guilabel:`Next`.
133+
134+
This will bring up the Project and Configuration window.
135+
136+
.. image:: images/creating-robot-program/new-project-creator-location.png
137+
:alt: The project and configuration page of the WPILib New Project Creator
138+
139+
1. **Base Folder**: This determines the folder in which the robot project will be located.
140+
2. **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.
141+
3. **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.
142+
4. **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.
143+
5. **Enable Desktop Support**: Enables unit test and simulation support (see :doc:`/docs/software/wpilib-tools/robot-simulation/introduction`).
140144

141145
.. warning:: Creating projects on OneDrive is not supported as OneDrive's caching interferes with the build system. Some Windows installations put the Documents and Desktop folders on OneDrive by default.
142146

143-
An example after all options are selected is shown below.
147+
Once all the above have been configured, click :guilabel:`Next`.
148+
149+
This will bring up the Review and Create window.
144150

145151
.. image:: images/creating-robot-program/new-project-creator-configured.png
146-
:alt: The new project creator screen filled out.
152+
:alt: The review and create page of the WPILib New Project Creator
153+
154+
Double check all the settings and click :guilabel:`Create Project`. If anything is not correct, click :guilabel:`Back` and make the necessary corrections.
155+
156+
.. note:: Any errors in project generation will appear in the bottom right-hand corner of the screen.
147157

148158
## Opening The New Project
149159

-28.6 KB
Loading
74.2 KB
Loading
90.9 KB
Loading
-53.5 KB
Loading

source/docs/zero-to-robot/step-4/creating-test-drivetrain-program-cpp-java-python.rst

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,28 +16,47 @@ Bring up the Visual Studio Code command palette with :kbd:`Ctrl+Shift+P`. Then,
1616
.. image:: /docs/software/vscode-overview/images/creating-robot-program/create-new-project.png
1717
:alt: Choose "WPILib: Create a new project".
1818

19-
This will bring up the "New Project Creator Window:"
19+
This will bring up the "WPILIb New Project Creator"
2020

2121
.. image:: /docs/software/vscode-overview/images/creating-robot-program/new-project-creator.png
22-
:alt: The different parts of the new project creation window.
22+
:alt: The project type selector of the WPILib New Project Creator
2323

24-
The elements of the New Project Creator Window are explained below:
24+
The **Project Type** chooses between an empty template project, or a :doc:`WPILib example project </docs/software/examples-tutorials/wpilib-examples>`. For this example, select :guilabel:`Example` and then choose :guilabel:`Next`.
2525

26-
1. **Project Type**: The kind of project we wish to create. For this example, select **Example**
27-
2. **Language**: This is the language (C++ or Java) that will be used for this project.
28-
3. **Project Base**: This box is used to select the base class or example to generate the project from. For this example, select **Getting Started**
29-
4. **Base Folder**: This determines the folder in which the robot project will be located.
30-
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.
31-
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. project folder will be given if the Create New Folder box is checked.
32-
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.
33-
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. For this example, do not check this box.
26+
This will bring up the language and base selection window.
3427

35-
Once all the above have been configured, click "Generate Project" and the robot project will be created.
28+
.. image:: /docs/software/vscode-overview/images/creating-robot-program/new-project-creator-language.png
29+
:alt: The language and base page of the WPILib New Project Creator
3630

37-
.. note:: Any errors in project generation will appear in the bottom right-hand corner of the screen.
31+
1. **Language**: This is the language (C++ or Java) that will be used for this project.
32+
2. **Project Base**: This box is used to select the base class or example to generate the project from. For this example, select **Getting Started**
33+
34+
After making the selections, click :guilabel:`Next`.
35+
36+
This will bring up the Project and Configuration window.
37+
38+
.. image:: /docs/software/vscode-overview/images/creating-robot-program/new-project-creator-location.png
39+
:alt: The project and configuration page of the WPILib New Project Creator
40+
41+
1. **Base Folder**: This determines the folder in which the robot project will be located.
42+
2. **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.
43+
3. **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.
44+
4. **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.
45+
5. **Enable Desktop Support**: Enables unit test and simulation support (see :doc:`/docs/software/wpilib-tools/robot-simulation/introduction`). 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. For this example, do not check this box.
3846

3947
.. warning:: Creating projects on OneDrive is not supported as OneDrive's caching interferes with the build system. Some Windows installations put the Documents and Desktop folders on OneDrive by default.
4048

49+
Once all the above have been configured, click :guilabel:`Next`.
50+
51+
This will bring up the Review and Create window.
52+
53+
.. image:: /docs/software/vscode-overview/images/creating-robot-program/new-project-creator-configured.png
54+
:alt: The review and create page of the WPILib New Project Creator
55+
56+
Double check all the settings and click :guilabel:`Create Project`. If anything is not correct, click :guilabel:`Back` and make the necessary corrections.
57+
58+
.. note:: Any errors in project generation will appear in the bottom right-hand corner of the screen.
59+
4160
## Opening The New Project
4261

4362
.. image:: /docs/software/vscode-overview/images/importing-previous-project/opening-project.png

0 commit comments

Comments
 (0)