Setting Up Git

1. Create a GitHub account

2. Install Git

   1. Note Git is already installed on macOS

   2. Download for Windows

      1. Make sure you install Git Bash along with your installation, and leave everything else default

   3. If you’re already using Linux I bet you know what Git is

      1. For Ubuntu, run apt-get install git

      2. For Arch Linux, run pacman -S git

3. Set up SSH tokens (This presentation might help guide)

   1. First, run ssh-keygen in the CLI anywhere, and just leave everything default by pressing enter

   2. Navigate to ~/.ssh/ and open id_rsa.pub in a text editor

   3. Copy the ssh key listed in this file into your GitHub’s SSH keys here

   4. If you have multiple machines, you’ll need to do this for each machine (i.e. dual booting or using a VM)

4. Run these two commands to save your GitHub credentials

   1. $ git config --global user.name "John Doe"
      $ git config --global user.email johndoe@example.com

5. View the Git 101 Presentation below if you’re not familiar with Git

Getting Up to Speed with the NER GitHub

Assuming you have GitHub access, Git installed on your machine, and SSH keys set up, you should be entirely ready to clone a repo! If you are confused by any of the terminologies I go into below, use the “Git 101” presentation above for reference.

Upon loading the page, you’ll be presented with a bunch of repos that NER uses. Here are some of the big ones for engineering:

• Embedded_Code

  • Contains all the embedded code we use on the car for controls and telemetry

• NERduino

  • Contains a base library for controlling the NERduino board

  • Is a dependency for a few repos

• Schematics22A

  • Contains all the KiCAD schematics for 22A

• Telemetry-Hub

  • Contains the codebase for the Telemetry Hub Python GUI application

• shepherd_bms

  • Contains the code for shepherd_bms controls and testing

Now let’s say you actually want to contribute, so you’ll want to clone whatever repository you're going to be working in. I want to clone the Embedded_Code repo, I'd go into that repo, click on the green "Code" button above the file structure in the repository and copy the link, so it would be

git clone git@github.com:Northeastern-Electric-Racing/Embedded_Code.git