First some terminology:¶

• Remote repository = A library or program which is published on mbed.org.
• Local repository = A library or program which is in your private workspace. A Local repository may be 'linked' to a Remote repository if it was imported or published.
• Pull = Copy changes from remote repository to a local one in your private workspace.
• Push = Copy changes from your private workspace to a published repository
• Fork = Create a clone of a published repository on mbed.org under your account.
• Publish = Publish changes to existing repository or create new one (fork)

Getting started¶

The most basic (and the most popular) usage of the collaboration system is to support the traditional workflow where one author works on a project, and other people import the project.

When an author releases new updates to a project, users are notified of the updates and can upgrade to the latest version

This works in a very similar way to the existing mbed publishing system. The author publishes a program or library and others can import it.

Users who have imported a program or library can quickly check for new versions in the Browser panel under the Summary pane on right or view detailed information about the repository in the Revisions panel.

About importing a repository¶

When you import a repository, you are making a clone of a public repository and putting it in your private workspace.

A imported repository can either be a whole program or a library for a program.

A repository can contain dependencies on other repositories. For example, a library may need another library in order to work. All dependencies will be imported for you automatically when you import a repository.

When you import a repository, the clone in your workspace will be "linked" to the public repository by URL.

To import a repository, simply click the Import link on the repository on the mbed website, or use the Import button within the mbed Compiler.

Getting updates¶

When the author of a repository releases new versions of their work, you will see something like the following in the Revisions Pane.

This indicates there are changes available. You can also view the details of each available change.

To get the latest version of the code, simply click the 'Update' button.