Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.64 KB

CLONING.md

File metadata and controls

39 lines (24 loc) · 1.64 KB
Raw

Cloning this repository

There are several reasons why you might want to create a clone of this repository on your local machine. These range from experimenting with the codebase, over creating your own schema customizations, to contributing to the development of the MEI schema and guidelines.

For a proper setup of your clone, you need to make a so-called recursive clone.

Creating a recursive clone of this repository

To include the TEI Stylesheets which are needed for transforming the ODD files, e.g. to RNG schema files, the music-encoding repository uses a mechanism provided by Git that is called submodule. It allows you to reference third-party code used in your own project without including the code in your repository.

Cloning a repository including the referenced submodules is referred to as creating a recursive clone.

  • If you do not have a clone on your local machine yet run the following from your command line:

    git clone https://github.com/music-encoding/music-encoding.git --recursive

    This will create a recursive clone of the repository, making sure all submodules (currently only the TEI Stylesheets) are properly initialized and pulled from their respective repositories.

  • If you already have a clone on your system you still might have to initialize the submodules by running the following commands from the command line:

    Switch to your clone's directory:

    cd [YOUR-CLONE-LOCATION]

    Initialize the submodules:

    git submodule init

    Update the submodules:

    git submodule update