Skip to content

docs(README): add visible roscore prerequisite before runtime usage (closes #125)#126

Merged
ycpss91255 merged 1 commit into
mainfrom
docs/125-runtime-roscore-prereq
May 27, 2026
Merged

docs(README): add visible roscore prerequisite before runtime usage (closes #125)#126
ycpss91255 merged 1 commit into
mainfrom
docs/125-runtime-roscore-prereq

Conversation

@ycpss91255
Copy link
Copy Markdown
Contributor

Summary

Closes #125. Add a visible blockquote prerequisite callout before the
make run -- -t runtime command in all four README translations.

Changes

All 4 languages (en / zh-TW / zh-CN / ja):

  • Added a > **Prerequisite:** blockquote immediately above the
    runtime code block explaining that roscore must be running on
    the host network beforehand, and describing the silent idle
    behavior when it is missing.
  • Removed the now-redundant inline comment from the code block.

Test plan

  • All 4 READMEs updated consistently.
  • CI green.

…loses #125)

The runtime subsection buried the roscore requirement inside a code
block comment. Users who skip to 'make run -- -t runtime' see a
single 'Connection refused' line and then silence, with no actionable
hint. Add a blockquote callout immediately before the command in all
4 languages so the prerequisite is visible before execution.
@ycpss91255 ycpss91255 enabled auto-merge (squash) May 27, 2026 07:12
@ycpss91255 ycpss91255 merged commit 3842851 into main May 27, 2026
8 checks passed
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.

docs(README): add visible roscore prerequisite before runtime usage

1 participant