Skip to content

Adopt TRG 1.01 – README.md Standard #75

@CDiezRodriguez

Description

@CDiezRodriguez

Description

As a developer,
I want to improve the README.md file in compliance with TRG 1.01,
so that users and contributors can quickly understand the purpose, setup, and usage of the project, following Eclipse Tractus-X standards.

Acceptance Criteria

  • Add basic repository overview, purpose, and structure
  • Include installation instructions (or reference INSTALL.md if complex)
  • Provide usage examples and intended use
  • Add license information
  • Include troubleshooting tips and FAQs
  • Reference the CONTRIBUTING.md file for contribution guidelines
  • Add contact or support information
  • Display useful badges (build status, coverage, etc.)
  • Link architecture, admin, user, and API documentation if available (TRG 1.05–1.08)

Additional Information

  • Based on TRG 1.01 – README.md in the Eclipse Tractus-X Release Guidelines
  • For complex installations, use INSTALL.md (TRG 1.02)

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

Status

In Progress

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions