On Setting up the Code Repositories - Pattonville-Robotics/Library-of-Alexandria GitHub Wiki

Table of Contents

Preface

This process only needs to be done once! To pull changes from others, simple use the blue downward-facing arrow button "Update Project" in Android Studio to update all projects.

Step-by-step Instructions

Setting up GitHub

  1. Create a GitHub account. Add your name, email, etc.
  2. Get invited to the Pattonville Robotics organization.
  3. Get added to the appropriate team.

Setting up Android Studio

  1. Open Android Studio and go to Configure -> Settings -> Version Control -> GitHub.
  2. Log in with your GitHub credentials and test your connection to verify.

Cloning the Main Repository

  1. Return to the welcome screen and go to "Check out project from Version Control" -> GitHub.
  2. Click the drop-down and select the repository titled "Main-Repository".
  3. Click "Clone" and wait for the download to complete. It will take some time on a slow network.
  4. "Yes" when a prompt appears asking if you would like to open a project file that was just checked out.
  5. Click "OK" on the "Import Project from Gradle" prompt to chose default settings.
  6. If there is no error, skip to step 8. If there is an error, cancel the import.
  7. Go to "Open an existing Android Studio project" and select and open the folder "~/StudioProjects/Main-Repository"
  8. Click "Add root" on the "Unregistered VCS Root Detected" prompt to tell Android Studio that this project is a Git repository.

Setting up Git

  1. Open the "Terminal" tab in Android Studio.
  2. Type the following: git config --global user.email "[email protected]", replacing the example email with the one supplied in Setting up GitHub, and press "return".
  3. Type the following: git config --global user.name "Mona Lisa", replacing the fake username with your own first and last name. This is not your username!

Cloning the rest of the Repositories

Repositories to be Cloned

For Each Repository to be Cloned

  1. Navigate to the repository page by clicking on the above link.
  2. Click on the green "Clone or download" button and copy the web URL, i.e. https://github.com/Pattonville-Robotics/Common-Code.git
  3. Return to the "Terminal" tab of Android Studio and type in rm -r $repository_name and press return, where $repository_name is the name of the repository you are currently cloning.
  4. Type in git clone $repository_url, where $repository_url is the web URL you copied in step 2. This process will take some time on a slow network.
  5. When prompted by Android Studio in the "Event Log" tab, click the "Add root" option.
  6. Go back to step 1 using the next repository on the list above or finish if you have cloned every repository in the list.

Preventing mistakes

  1. Open the "Version Control" tab in Android Studio.
  2. Press the blue refresh symbol "Refresh VCS Changes".
  3. Click the green plus "Create new changelist" and title it "Don't Commit".
  4. Drag the 4 unknown files named for each repository to the new changelist called "Don't Commit".

For extra help setting up, contact @magneticflux-