Skip to content

Commit 22617aa

Browse files
Clean up WPILib setup (#3023)
Add introduction Clarify cases where python teams would want to install (fixes #2988) correct tools installed Put OS pictures note in a better location Co-authored-by: Jason Daming <[email protected]>
1 parent 6441cac commit 22617aa

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

source/docs/zero-to-robot/step-2/wpilib-setup.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# WPILib Installation Guide
22

3-
This guide is intended for Java and C++ teams. LabVIEW teams can skip to :doc:`labview-setup`. Python teams can skip to the :doc:`python-setup`. Additionally, the below tutorial shows Windows 11, but the steps are identical for all operating systems. Notes differentiating operating systems will be shown.
3+
This guide will walk you through installing the WPILib development environment on your computer. This includes the WPILib tools, Visual Studio Code, and all dependencies needed to develop and deploy code to the roboRIO. WPILib Installation is required for Java and C++ teams. LabVIEW teams can skip to :doc:`labview-setup`. Python teams can do a full install per these instructions to get a Visual Studio Code environment with some python extensions, or do a tools only installation to install dashboards such as Shuffleboard and Elastic. Python teams additionally need to follow the :doc:`python-setup`.
44

55
## Prerequisites
66

@@ -15,6 +15,8 @@ Supported Operating Systems and Architectures:
1515

1616
.. note:: C++ compilation is memory intensive. A minimum of 32 GB of RAM is recommended for C++ teams.
1717

18+
This tutorial shows Windows 11, but the steps are identical for all operating systems. Notes differentiating operating systems will be shown.
19+
1820
WPILib is designed to install to different folders for different years, so that it is not necessary to uninstall a previous version before installing this year's WPILib.
1921

2022
## Downloading
@@ -95,8 +97,8 @@ Upon opening the installer, you'll be presented with the below screen. Go ahead
9597

9698
This showcases a list of options included with the WPILib installation.
9799

98-
- :guilabel:`Tools Only` installs just the WPILib tools (Pathweaver, Shuffleboard, RobotBuilder, SysId, Glass, and OutlineViewer) and JDK.
99-
- :guilabel:`Everything` installs the full development environment (VS Code, extensions, all dependencies), WPILib tools, and JDK.
100+
- :guilabel:`Tools Only` installs just the WPILib tools (:doc:`SmartDashboard </docs/software/dashboards/smartdashboard/index>`, :doc:`Shuffleboard </docs/software/dashboards/shuffleboard/index>`, :doc:`RobotBuilder </docs/software/wpilib-tools/robotbuilder/index>`, :doc:`OutlineViewer </docs/software/wpilib-tools/outlineviewer/index>`, :doc:`PathWeaver </docs/software/pathplanning/pathweaver/index>`, :doc:`Glass </docs/software/dashboards/glass/index>`, :doc:`SysId </docs/software/advanced-controls/system-identification/index>`, :ref:`Data Log Tool <docs/software/telemetry/datalog-download:Managing Data Logs with the DataLogTool>`, :doc:`roboRIO Team Number Setter </docs/software/wpilib-tools/roborio-team-number-setter/index>`, :doc:`AdvantageScope </docs/software/dashboards/advantagescope>`, :doc:`Elastic </docs/software/dashboards/elastic>`, :doc:`WPIcal </docs/software/wpilib-tools/wpical/index>`) and JDK.
101+
- :guilabel:`Everything` installs the full development environment (VS Code, extensions, all dependencies, C++ compiler and JDK), WPILib tools, and documentation
100102

101103
You will notice two buttons, :guilabel:`Install for this User` and :guilabel:`Install for all Users`. :guilabel:`Install for this User` only installs it on the current user account, and does not require administrator privileges. However, :guilabel:`Install for all Users` installs the tools for all system accounts and *will* require administrator access. :guilabel:`Install for all Users` is not an option for macOS and Linux.
102104

0 commit comments

Comments
 (0)