docs(README): replace stale ./build.sh refs with make interface (#117)#118
Merged
Conversation
Post base#330 (v0.30.0), wrappers moved from repo root to script/ and the canonical entry point became `make build` / `make run` / `make exec` / `make stop`. All four READMEs still referenced the old root-level `./build.sh` etc. Changes across all 4 languages (en / zh-TW / zh-CN / ja): - TL;DR, Quick Start, Usage, Demo sections: `./build.sh` -> `make build`, `./run.sh` -> `make run`, etc. - Directory structure tree: remove stale root symlink entries, add wrapper symlinks under script/ where they actually live. - Switch ROS 2 distro section: `./setup.sh` -> `make setup`, `./setup_tui.sh` -> `make setup-tui`. Container-internal paths (/root/demo/) unchanged (confirmed via Dockerfile COPY). Closes #117
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #117. All four READMEs (en / zh-TW / zh-CN / ja) still
referenced root-level
./build.sh,./run.sh,./exec.shfrom thepre-v0.30.0 layout. Since base#330, wrappers live under
script/andthe canonical entry point is
make build/make run/make exec/make stop.Changes (all 4 languages)
./build.sh->make build,./run.sh->make run, etc.(
build.sh -> .base/...), added wrapper symlinks underscript/where they actually live.
./setup.sh->make setup --,./setup_tui.sh->make setup-tui./root/demo/) unchanged (confirmed viaDockerfile COPY).
Test plan
grepacross all 4 READMEs for./build.sh,./run.sh,./exec.sh,./stop.shreturns zero matches.makeflag-forwarding syntax verified against Makefile(positional args pass through, flags need
--separator).