[WIP] Fix spelling and textual errors in README.md

[Copilot]

Plan to Fix README Errors and Add Synchronization

• Fix German README.md errors:
  • Line 17: Complete truncated word "unterwegs"
  • Line 59: Change "viertel" → "Viertel" (noun capitalization)
  • Line 64: Update "bewußt" → "bewusst" (new German spelling)
  • Line 82: Fix typo "aufrufen" → "Aufrufen"
  • Line 94: Change "Vibe Coding" → "AI-assisted Coding"
  • Line 159: Fix "Unteverzeichnis" → "Unterverzeichnis"
  • Fix script name inconsistencies (standardize to setup_can_marklin.sh and can-health-check.sh)
  • Add language switcher at the top
• Rename README-en.md to README.en.md
• Update English translation with:
  • Correct script names
  • Language switcher at the top
  • Any improvements needed for fluency
• Create GitHub Action workflow .github/workflows/readme-consistency-check.yml to check README synchronization
• Run code review and security checks
• Test and verify all changes

Original prompt

Objective

Fix spelling and textual errors in README.md, add a fluent English translation (README.en.md), and implement a GitHub Action workflow to ensure both versions stay synchronized.

Changes Required

1. README.md - Corrections and Improvements

Fix the following issues in the German README.md:

Spelling and Grammar Errors:

• Line 17: Complete the word "unterwegs" (currently truncated)
• Line 94: Change "Vibe Coding" to "AI-assisted Coding" (more standard terminology)
• Line 106: Ensure consistency with "automatische Systemkonfiguration"
• Line 159: Fix "Unteverzeichnis" → "Unterverzeichnis"
• Line 60: Change "viertel" → "Viertel" (noun capitalization)
• Line 64: Update "bewußt" → "bewusst" (new German spelling)
• Line 82: Capitalize "Aufrufen" → "Aufrufen"

Script Name Inconsistencies:
Fix the inconsistent script filenames throughout the document:

• Line 108: States setup-can.sh (with hyphen)
• Line 112: Uses chmod +x setup_can.sh (with underscore)
• Line 116: Uses sudo ./setup_can_marklin.sh (different name entirely)
• Line 124: Copy-paste error - should be chmod +x can-health-check.sh not setup_can.sh

Standardize to: setup_can_marklin.sh and can-health-check.sh

Additional Improvements:

• Add language switcher at the top: **[🇩🇪 Deutsche Version](./README.md)** | **[🇬🇧 English version](./README.en.md)**
• Minor punctuation improvements

2. README.en.md - New English Translation

Create a complete, fluent English translation of README.md:

• File name: README.en.md
• Must be natural and fluent for native English speakers
• Maintain the same structure and formatting as the German version
• Include the same language switcher at the top
• Translate technical terms appropriately (e.g., "Gleisbox" → "track box", "Stellwerk" → "signal box")
• Keep code blocks and commands identical
• Preserve the author's friendly, educational tone

3. GitHub Action Workflow - Translation Consistency Check

Create .github/workflows/readme-consistency-check.yml:

Purpose: Automatically check if both README files are updated together

Features:

• Trigger on push to main branch when README.md or README.en.md changes
• Trigger on pull requests that modify either README file
• Compare which files were changed
• If only one README was updated, create a warning annotation
• For pull requests, add a comment warning that both versions should be synchronized
• Use actions/checkout@v4 and actions/github-script@v7

Logic:

IF README.md changed AND README.en.md NOT changed:
  → Warning: "Only README.md was updated. Please also update README.en.md"
  
IF README.en.md changed AND README.md NOT changed:
  → Warning: "Only README.en.md was updated. Please also update README.md"
  
IF both changed OR neither changed:
  → No warning

Files to Modify/Create

1. Modify: README.md - Fix all errors and add language switcher
2. Create: README.en.md - Complete English translation
3. Create: .github/workflows/readme-consistency-check.yml - Consistency checker

Quality Standards

• German text must use correct neue Rechtschreibung
• English text must be fluent and natural for native speakers
• All script names must be consistent throughout both documents
• Both README files must have identical structure
• GitHub Action must work on both push and pull_request events

Expected Outcome

After this PR:

• README.md is error-free with proper German spelling
• README.en.md provides a complete, professional English translation
• Language switcher allows easy navigation between versions
• Automated workflow warns when translations become out of sync
• All script filenames are consistent and correct

This pull request was created from Copilot chat.

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.