Skip to content

docs: improve readme #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 2, 2025
Merged

docs: improve readme #24

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
08f51d6
docs: improve readme
reshnm Jul 1, 2025
113d0ea
fix spelling
reshnm Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,20 @@

## About this project

Open Managed Control Planes
This repository contains the umbrella openMCP component, which is a collection of openMCP open-source components which can be deployed together to create an openMCP landscape.
The component is built with the [Open Component Model (OCM)](https://ocm.software). This component does not contain any resource definitions, but only references to other components.
The referenced components are defined in the file `component-constructor.yaml` in the root directory of this repository.
The versions of the referenced components are defined in the file `component-versions.yaml` in the root directory of this repository.

## Requirements and Setup

*Insert a short description what is required to get your project running...*
For accessing the openMCP component, the OCM CLI is required. The OCM CLI can be installed via the [OCM CLI documentation](https://ocm.software/docs/getting-started/installation/).
To view a specific version of the openMCP component inclusive all dependencies, use the following command:

```bash
OPENMCP_VERSION=v0.0.7
ocm get component --repo=OCIRegistry::ghcr.io/openmcp-project/components github.com/openmcp-project/openmcp:${OPENMCP_VERSION} -o yaml --recursive
```

## Support, Feedback, Contributing

Expand Down