docs: update README

[vrdc-sap]

Description

Changes proposed in this pull request:

• update README

[hyperspace-insights]

Summary

The following content is AI-generated and provides a summary of the pull request:

---

docs: Update README with Project-Specific Content

Documentation

📝 Replaced the generic project README template with actual project-specific documentation for the GPU module.

Changes

• README.md: Replaced all placeholder/template content with real documentation including:
  • Added REUSE status and build badges at the top
  • Overview: Describes the GPU module's role in managing the NVIDIA GPU Operator lifecycle on SAP BTP Kyma runtime clusters
  • Prerequisites: Lists required Kyma cluster GPU machine types and kubectl
  • Installation: Step-by-step instructions for deploying the operator and Gpu CR, with expected output and versioned install examples
  • Usage: Documents the Gpu custom resource spec, optional driver version pinning, and a status conditions reference table
  • Development: Adds make commands for building/testing, and GoLand IDE debug setup instructions
  • Embedded NVIDIA GPU Operator Chart: Documents the embedded Helm chart approach using Go's //go:embed directive

---

• 🔄 Regenerate and Update Summary
• ✏️ Insert as PR Description (deletes this comment)
• 🗑️ Delete comment

PR Bot Information

Version: 1.21.0

• File Content Strategy: Full file content
• LLM: anthropic--claude-4.6-sonnet
• Event Trigger: pull_request.opened
• Summary Prompt: Default Prompt
• Correlation ID: 3b4d2b46-3ba0-46b8-a869-72312d89d1f9
• Output Template: Default Template

[hyperspace-insights]

The README is a significant improvement over the template placeholder. Two minor issues were flagged: the Azure machine type prefix is inconsistent with the actual detection logic (NC vs Standard_NC), and the Development section omits the make chart-refresh target, which could confuse contributors trying to upgrade the embedded chart.

PR Bot Information

Version: 1.21.0

• File Content Strategy: Full file content
• Agent Instructions:
  • CLAUDE.md
• LLM: anthropic--claude-4.6-sonnet
• Event Trigger: pull_request.opened
• Correlation ID: 3b4d2b46-3ba0-46b8-a869-72312d89d1f9