Tooling Setup

Tooling Setup

This document is based off of the 971 Github Setup document

Windows Users

It's highly suggested that you install Windows Subsystem for Linux (WSL) and use that as your terminal. It will make your life easier. If you are not sure whether you have WSL, run wsl in the command prompt or type wsl in the search bar.

GitHub Setup

1. Create a GitHub account

If you don't have one, create one.

SSH Access to GitHub

We'll use GitHub's official CLI tool to set up SSH access automatically.

2. Install GitHub CLI

For Debian/Ubuntu or WSL, run:

sudo apt install gh

For MacOS, run:

brew install gh

To confirm it's installed correctly, run:

gh --version

3. Authenticate and set up SSH

Run this command to sign in to GitHub and set up SSH:

gh auth login

• When asked to choose a GitHub host, choose GitHub.com
• For protocol, choose SSH
• Don't use a passphrase
• Authenticate using "Login with a web browser"
• Continue following the instructions. It will generate and register your SSH key with GitHub automatically.

You can confirm that everything worked by running:

gh auth status

This should say you're logged in with SSH.

4. Test SSH connection

Test the SSH connection to GitHub:

ssh -T git@github.com

You should see a success message with your username. If not, follow the troubleshooting steps at: https://docs.github.com/en/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection

5. Optional: Set up commit signing with SSH

If you'd like to sign your commits using SSH, run:

git config --global gpg.format ssh
git config --global user.signingkey ~/.ssh/id_ed25519.pub

WPILib and VS Code

6. Install WPILib/VSCode

Follow the instructions here: https://docs.wpilib.org/en/stable/docs/zero-to-robot/step-2/wpilib-setup.html

• Select "Install for this User"
• Install "Everything"
• Choose "Download for this computer only"

Download the Training Repository

7. Get access to the GitHub organization

If you completed the software training sign up form on time, you should have already been added to the "Spartan Robotics" GitHub organization and be able to access the training-2025 repo.

If not, ask a training lead (e.g. on Slack) to be added to the organization. Provide them with your GitHub username.

8. cd to the location where you want the training-2025 folder

Windows users only:

It’s recommended to save source code to your Windows home directory (C:\Users\<username> or /mnt/c/Users/<username> in WSL) so that apps like VSCode, notepad, etc. can access it easily.

Then do a soft link from the WSL home directory to it so you can access it easily from the terminal.

cd /mnt/c/Users; cd $USER

If that doesn't work, type:

ls -1d /mnt/c/Users/*

to see what home directories are available and cd into it.

Once you are sure that you are in the location where you want to source, do:

ln -sf $PWD/training-2025 ~/training-2025

9. Clone the repository

git clone git@github.com:frc971/training-2025.git

If you don't have git, download it here.

Open in VS Code

10. Open the folder

• Go to File -> Open Folder
• Navigate to the directory where you did git clone
• Go inside training-2025 and click Open

Final Step

11. Read CONTRIBUTING.md