Installing TortoiseGit for repository access - quasics/quasics-frc-sw-2015 GitHub Wiki

THESE INSTRUCTIONS ARE CURRENTLY BEING WRITTEN, AND ARE BEING PREPARED ON A NON-WINDOWS MACHINE (MEANING THAT THEY CAN'T BE TESTED AS THE WRITEUP IS PREPARED). AS A RESULT, IT IS LIKELY THAT THEY WILL UNDERGO SOME CHANGES, SO PLEASE TAKE THEM AS ONLY INITIAL GUIDANCE, AND NOT "THE DEFINITE THING TO DO"!

TortoiseGit is a tool that integrates directly with the Microsoft Windows File Explorer, allowing you to work with a repository via context menus (e.g., the menus that show up when you right-click on things) and affecting the icons that are shown for files/directories in Windows. It's one of the most commonly-used (GUI) Git tools in the Windows world.

However, it depends on some additional pieces of software that need to be installed separately, so the process isn't quite click-and-go.

Step 1: Install Notepad++

  1. Go to https://notepad-plus-plus.org/downloads/.
  2. Click on the link shown in the menu on the left-hand side for "Current Version X.Y.Z".
  3. Click on the link to download the installer for your machine.
  4. Run the installer, and accept all of the default settings along the way.

Step 2: Install GitForWindows

  1. Go to https://gitforwindows.org/.
  2. Click on the link at the top to download the installer for your machine.
  3. When the download completes, run the installer.
  4. Accept all of the default settings, with the following exceptions:
    • When prompted to choose an editor, select "Notepad++".

Step 3: Install TortoiseGit

  1. Go to https://tortoisegit.org/download/.
  2. Click on the link to download the installer for your version of Windows (e.g., 32-bit, 64-bit, etc.).
    • The download should begin automatically.
  3. Run the downloaded installer.
  4. Accept all of the default settings, with the following exceptions:
    • When prompted to select an SSH client, pick the radio button for "TortoiseGitPlink".
      tortoisegit-ssh
  5. When the installer completes, it will then kick off a "First Start Wizard".
    • It may also prompt you to reboot; hold off on doing this.
  6. Within the "First Start Wizard":
    • When prompted to "Configure git.exe", the wizard should be able to find the executable that was installed from GitForWindows. Click on the "Check now" button to confirm, and it should update the window to show a version number.
      tortoisegit-firststart-config
    • When prompted to configure user information, fill in your name and email address. (On team laptops, we're using "Quasics FRC" as the user name, and "[email protected]" as the email address.)
      tortoisegit-firststart-email

Follow-on, to be added to general config

Update the set of ignored files/directories

There are a number of files/folders created by VSCode when working with FRC programs that should not be added to version control, but which can be easily added by mistake and subsequently cause problems for other folks. As a result, we also want to make sure that we ensure that the list of files that will be ignored by default includes those that we worry about when working in FRC.

TODO: Add instructions for editing the file specified by the core.excludesFile setting in the user’s ~/.gitconfig (%HOME%/.gitconfig under Windows). Format of the file is covered at https://git-scm.com/docs/gitignore.

git config --get core.excludesfile
git config --global core.excludesfile ~/.gitignore_global

# Files/directories used with FRC tools
build
.gradle
.tracecompass
imgui.ini
simgui-ds.json
simgui-window.json
simgui.json
networktables.ini
networktables.json

Home

⚠️ **GitHub.com Fallback** ⚠️