Using Github Desktop

GitHub Desktop will allow you to easily retrieve updates created in the Tympan_Library.

This page will walk through the steps for installing and using GitHub Desktop on your computer.

1. Move Current Tympan_Library Folder
2. Install GitHub Desktop
3. Clone Tympan Library Repository
4. Fetch Library Updates

Move Current Tympan_Library

If you have not yet downloaded and installed the Tympan_Library from GitHub, you can skip this step.

• Locate the Tympan_Library Folder in your documents. It will most likely be in a file path similar to: C:\Users\amv\Documents\Arduino\libraries.
• Move or delete this file. You will be re-installing it using the GitHub Desktop

Install GitHub Desktop

You will not need a GitHub account to complete this step. Creating an account is optional.

• Click this link to go to https://desktop.github.com

• Select download for your operating system.

• At the Welcome screen select your option choice:

  • Create a free account
  • Sign into GitHub
  • Skip this step

• If you choose to Skip this step you will be directed to a configuration screen. Enter your name or alias and a valid email address.

• Whether you have signed in or configured git you should now be viewing your GitHub Desktop home screen. To retrieve the Tympan_Library, select Clone a repository

Cloning a Repository

By cloning a repository, you have access to all of the material normally stored on the GitHub project page. This allows files to be updated and transferred easily without having to download zip files. You will also be able to view changes in the repository line-by-line, a very helpful approach to modifying your own code or understanding the changes implemented by others.

• A pop up window will appear where you will need to enter:
  • Repository URL
  • Local Path

Location of the Repository

You can find the location of the repository at the Tympan_Library page on GitHub

• Select Clone or download and a pop down with web URL will appear. Simply copy and paste this URL into the Repository URL field on the GitHub desktop.

File Path Location

NOTE: It is important to choose the same file path the Tympan_Library was previously located, in the Arduino folder. This is where the Arduino will look for the file.

• Select Clone and the Tympan_Library should now be part of your GitHub Desktop. Select the History tab to see the latest efforts and commits in the library.

• Return to the original location of the Tympan_Library folder to make sure it is there as expected. Open the folder and notice the new .git files that indicate it's pairing with the GitHub desktop.

Fetch Library Updates

• To retrieve any updates, or new programs that may have been made in GitHub, go to your GitHub Desktop and select Fetch Origin

• If there are any changes, the field will change to say Pull origin with a number and down arrow indicating how many committed changes have been made since your last fetch. Select Pull origin to commit those changes to your computer.

• Once pulled all the changes will show up in detail in under the History tab.

This is a very easy and simple way to stay updated on any new programs or changes that may occur as the Tympan evolves. You can Fetch origin just before each play session with your Tympan, or follow the conversations on the Tympan Forum and fetch new material as it becomes the latest buzz.