Working With GitHub

The new MPLAB® Xpress is able to access projects stored on GitHub, Bitbucket, or your own Git repository. For this discussion, the focus will be on GitHub.

GitHub is a platform were you can store, share and version control your MPLAB Xpress projects. It is built on the Git version control software.

If you have existing projects in the old MPLAB Xpress, you can save and migrate them to GitHub and then easily access them in the new MPLAB Xpress.

Saving Projects for Migration

To save your old MPLAB Xpess projects to your local computer so they may be migrated to GitHub, click to view the video link above or follow the steps below.

  1. In the old MPLAB Xpress, open the project you wish to export.
  2. Select File > Package as MPLAB Project.
  3. The project will be zipped and saved to your local machine.

Migrating Projects to GitHub

Once you have saved your old MPLAB Xpress projects to your local computer, you can move them to GitHub.

Sign In

Go to https://github.com/ and sign in or sign up for an account.

If you are new to GitHub, follow the guidance on the main page after you log in. Useful resources are:

Create a Repository

NewRepositoryMenupng.png

Create a repository for one of your projects.

  1. In the upper right corner, next to your avatar, click and then select New repository.
  2. Name your repository with the name of your project.
  3. Write a short description.
  4. To write a longer description of your project, leave Initialize this repository with a README selected.
  5. Click Create repository.

Save Project Files to Repository

UploadFiles.png

To move the project to the GitHub repository:

  1. Unzip the project file to your PC.
  2. On the GitHub repository page:
    1. Drag and drop the project folder (Project.X) to the repository space. GitHub will add all the files to your repository.
    2. Click the Upload Files button. Move the project files into the space provided to add them to your repository.
  3. Add a description and click Commit Changes.

Accessing GitHub from MPLAB Xpress

Select File > Git to enter the location of a Git repository with one of your projects. Then enter your username and password to clone the repository to your workspace. Once cloned, the project will open in MPLAB Xpress.

To re-open the project at another time, use File > Open Project to find and open the project.

Go to View > Git Controls to access all the Git features like push, pull, merge, create branch, etc.

Find GitHub examples at:
https://github.com/microchip-pic-avr-examples

© 2020 Microchip Technology, Inc.
Notice: ARM and Cortex are the registered trademarks of ARM Limited in the EU and other countries.
Information contained on this site regarding device applications and the like is provided only for your convenience and may be superseded by updates. It is your responsibility to ensure that your application meets with your specifications. MICROCHIP MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WHETHER EXPRESS OR IMPLIED, WRITTEN OR ORAL, STATUTORY OR OTHERWISE, RELATED TO THE INFORMATION, INCLUDING BUT NOT LIMITED TO ITS CONDITION, QUALITY, PERFORMANCE, MERCHANTABILITY OR FITNESS FOR PURPOSE. Microchip disclaims all liability arising from this information and its use. Use of Microchip devices in life support and/or safety applications is entirely at the buyer's risk, and the buyer agrees to defend, indemnify and hold harmless Microchip from any and all damages, claims, suits, or expenses resulting from such use. No licenses are conveyed, implicitly or otherwise, under any Microchip intellectual property rights.