Skip to content

docs: standardize Getting Started README for students - #30

Merged
javiergs merged 1 commit into
mainfrom
docs/standardize-readme
Oct 31, 2026
Merged

javiergs merged 1 commit into
mainfrom
docs/standardize-readme

Conversation

@javiergs

Copy link
Copy Markdown
Owner

Summary

Align the README with the shared Getting Started layout: title and badges, short introduction, hero image, requirements, quick start, Maven dependency, examples, API reference, and troubleshooting. Keep technology-specific safety, credentials, licensing, and maturity notes where appropriate.

Key changes

  • Reduce duplicated setup instructions and route detailed steps to existing student guides.
  • Keep published Maven versions and runnable commands unchanged.
  • Fix or remove obsolete links to root-level CONTRIBUTING.md after its relocation to .github/.
  • Remove unnecessary references to private implementation repositories.
  • Preserve RTDE4J's limited RTDE streaming scope, Turtle4J's simulator-versus-hardware distinction, Cortex4J's credentials/entitlements, and TULIP's destructive Taiga example warnings.

Documentation-only; no source code, dependency, CI, or branch protection changes.

@javiergs
javiergs merged commit dbec7e0 into main Oct 31, 2026
2 checks passed
@javiergs
javiergs deleted the docs/standardize-readme branch October 31, 2026 04:50
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.

1 participant