Skip to content

updated the readme which was the original tractus-x readme before#8

Open
rgalan-dev wants to merge 2 commits into
developfrom
feat/update-readme
Open

updated the readme which was the original tractus-x readme before#8
rgalan-dev wants to merge 2 commits into
developfrom
feat/update-readme

Conversation

@rgalan-dev
Copy link
Copy Markdown

WHAT

Updated the top-level README to better reflect the Construct-X EDC project instead of the upstream Tractus-X README.

The README now:

  • introduces the repository as the Construct-X EDC
  • explains the relationship to Eclipse Tractus-X EDC
  • provides a clearer project overview and inventory
  • links important development resources such as the local testbed
  • updates project-specific links and references

WHY

The previous README was still largely identical to the upstream Tractus-X repository and did not clearly communicate the Construct-X specific context, structure and development resources.

This change improves onboarding and repository navigation for developers working on Construct-X EDC.

FURTHER NOTES

  • Updated project and license links to point to the Construct-X repository
  • Removed outdated upstream-specific references and badges
  • Improved README structure and terminology for Construct-X specific development workflows

Closes #CXAP4-244

@rgalan-dev rgalan-dev self-assigned this May 28, 2026
@mhellmeier mhellmeier self-requested a review May 28, 2026 13:43
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md Outdated
Comment on lines +64 to +76
## Getting Started

### Build

Build Tractus-X EDC together with its Container Images
Build Construct-X EDC together with its Container Images

```shell
./gradlew dockerize
```

## Known Incompatibilities

- Hashicorp Vault 1.18.1 is not compatible with the EDC due to a bug in the vault concerning path handling
- [Internal Issue](https://github.com/eclipse-tractusx/tractusx-edc/issues/1772)
- [Hashicorp Vault Issue](https://github.com/hashicorp/vault/issues/29357)

```shell
./gradlew build
```
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Getting Started guide should not mention the dockerize and build command. Instead, it should link to the local setup.

I suggest combining the "Local Testbed" section from above with this Getting Started section. If people want to get into the topic, they should start with the local testbed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants