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.
Pick a name that you are willing to put on your resume and share with the world.

SSH Connection to GitHub

3. Check if you have SSH keys already

Run the following command in your terminal:

ls -1 ~/.ssh/*.pub

• If one or more .pub files are shown, you already have SSH keys.
• If you don't have any, generate them by following these instructions.

NOTE: Do not create a passphrase (password) unless you want to type in that password frequently.

NOTE 2: ~/.ssh/id_ed25519.pub is the public key. It is okay to share.
~/.ssh/id_ed25519 (without the .pub) is the private key. It is NOT okay to share with anyone or any website.

4. Copy the entire output of the following command:

cat ~/.ssh/id_ed25519.pub # <- update the filename as needed

5. Setup your signing keys:

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

6. Add your SSH key to GitHub:

• Go to https://github.com/settings/keys
• Click on "New SSH key"
• Enter anything in Title
• Set Key Type to Authentication Key
• Paste your public key into Key

If your public key's name isn't ~/.ssh/id_ed25519.pub, either:

• Create a key with that name. See above, OR
• Rename your existing key set, OR
• Add the following to ~/.ssh/config:

  Host github.com
    AddKeysToAgent yes
    User git
    IdentityFile ~/.ssh/id_ed25519 # Update with the key name.
  

7. Test SSH Connection

Follow the instructions here:
https://docs.github.com/en/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection

WPILib and VS Code

8. 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

9. 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/971-robot-2025 ~/971-robot-2025

10. 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

11. 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

12. Read CONTRIBUTING.md