Navigation

This section is primarily designed for the core OME developers who want to
check out the main code base using Git. If you need guidance in installing,
configuring and using Git, see the Using Git page.

Most OME development is currently happening on GitHub, therefore it is highly
suggested that you become familiar with how it works, if not create an account
for yourself.

Note

There is extensive guidance on the Using Git page and the
following examples assume you have set up your account using “gh” for your
personal repositories and “origin” as the official repositories as
described there.

Start by cloning the official repository for the project you want to work with
e.g.:

gitclonehttps://github.com/openmicroscopy/openmicroscopy.git

Since the openmicroscopy (OMERO) repository now makes use of submodules, you
first need to initialize all the submodules:

cdopenmicroscopygitsubmoduleupdate--init

Alternatively, with version 1.6.5 of Git and later, you can pass the
--recursive option to git clone and initialize all submodules:

Depending on which repository you cloned first, either origin/develop or
gh/develop will be the “develop” branch of your own fork of
openmicroscopy/openmicroscopy or openmicroscopy/bioformats. The example below
assumes that “gh” is your own personal GitHub repository, and “origin” is the
official openmicroscopy repository.

You may even want to remove the “develop” branch from your fork since all
branching should happen from the official develop branch. If you’d prefer to
keep a copy of “develop” in “gh”, that is fine, but you may then need to keep
your develop up-to-date with the official develop:

gitcheckoutdevelopgitreset--hardorigin/develop# Warning: This will delete any unsaved changes and commits to develop!gitpush-fghdevelop# Warning: This will replace gh/develop with the official version remotely.