diff --git a/README.md b/README.md index 49fba75..1d42d8f 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,14 @@ +# openMINDS build pipeline + +[![GitHub][license-shield]][license-url] +[![GitHub contributors][contributors-shield]][contributors-url] + +This branch contains the code for the build pipeline of this repository. The pipeline gathers the schemas from all metadata models (submodules), interprets and supplements with openMINDS vocabulary information. + ## Create a release -To create a release, define the version and its submodules inside the version.json. Run the "update_commits.py" with the attribute "--version X" which then updates the commit information to the current head of the configured submodule branches. Existing commit hashes for this version will be replaced. +To create a release, define the version and its submodules inside the **version.json**. Run the "update_commits.py" with the attribute "--version X" which then updates the commit information to the current head of the configured submodule branches. Existing commit hashes for this version will be replaced. ### version.json The version.json defines the submodule versions which are composing an openMINDS release. - -Versions defined without commit hash are supposed to point to head of the corresponding branch. If no branch is defined, this means that the latest commit on the **semantically highest version branch** is taken into account. \ No newline at end of file +Versions defined without commit hash are supposed to point to head of the corresponding branch. If no branch is defined, this means that the latest commit on the **semantically highest version branch** is taken into account.